Skip to content

Commit 00879a9

Browse files
ikhareConvex, Inc.
authored and
Convex, Inc.
committed
Make OSS readme wording more confident (#33290)
GitOrigin-RevId: 174c1c4397b8c674c56d4e3f762f24d391af2185
1 parent 61ae285 commit 00879a9

File tree

2 files changed

+15
-40
lines changed

2 files changed

+15
-40
lines changed

README.md

+5-25
Original file line numberDiff line numberDiff line change
@@ -19,43 +19,23 @@ application code.
1919
The best way to get started with Convex is to follow the
2020
[getting started guides in the Convex docs](https://docs.convex.dev/).
2121

22-
**Most Convex developers should be using the
23-
[managed hosted product](https://www.convex.dev/plans).** The hosted product
24-
includes a generous free tier and provides a seamless, reliable, cost-effective
25-
platform that allows you to focus on building your application without worrying
26-
about infrastructure.
27-
28-
**This repository is the wild west open source version.** It's the same code
29-
used in the hosted Convex product but runs on a single machine and doesn't
30-
include the scale-out services, replicated database backend, production
31-
dashboard, or operational tooling. You are welcome to use this code to run your
32-
application, either for local testing or in production, but you are on your own
33-
managing it and ensuring the system is reliable and secure. In particular you
34-
should ensure you have strong competency with regards to:
35-
36-
- Hosting
37-
- Traffic routing
38-
- Backups and replication
39-
- Monitoring
40-
- Upgrades
41-
- Migration between versions
22+
**[Convex managed hosted product](https://www.convex.dev/plans).** The hosted
23+
product includes a generous free tier and provides a seamless, reliable,
24+
cost-effective platform that allows you to focus on building your application
25+
without worrying about infrastructure.
4226

4327
No official support is provided for the open source version of Convex but
4428
community support is available in the `#open-source` channel in the
4529
[Convex Discord](https://discord.gg/convex). There is a
4630
[self-hosting guide](./SELFHOSTING.md) available with some guidance.
4731

48-
Development of the Convex backend is led by the Convex team and we are not
49-
actively soliciting any major contributions from the community. We of course
32+
Development of the Convex backend is led by the Convex team. We
5033
[welcome bug fixes](./CONTRIBUTING.md) and
5134
[love receiving feedback](https://discord.gg/convex). We keep this repository
5235
synced with any internal development work within a handful of days.
5336

5437
## Getting started
5538

56-
_We **strongly** recommend using the hosted version of Convex to get familiar
57-
with the development workflow before attempting to run this version locally._
58-
5939
To get started, clone this repo:
6040

6141
```sh

SELFHOSTING.md

+10-15
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,15 @@
66
</picture>
77
</p>
88

9-
**Most Convex developers should be using the
10-
[managed hosted product](https://www.convex.dev/plans).** The hosted product
11-
includes a generous free tier and provides a seamless, reliable, cost-effective
12-
platform that allows you to focus on building your application without worrying
13-
about infrastructure.
14-
15-
**This repository is the wild west open source version.** It's the same code
16-
used in the hosted Convex product but runs on a single machine and doesn't
17-
include the scale-out services, replicated database backend, production
18-
dashboard, or operational tooling. You are welcome to use this code to run your
19-
application, either for local testing or in production, but you are on your own
20-
managing it and ensuring the system is reliable and secure. In particular you
21-
should ensure you have strong competency with regards to:
9+
** [Convex managed hosted product](https://www.convex.dev/plans).** The hosted
10+
product includes a generous free tier and provides a seamless, reliable,
11+
cost-effective platform that allows you to focus on building your application
12+
without worrying about infrastructure.
13+
14+
You are welcome to use this code to run your application, either for local
15+
testing or in production, but you are on your own managing it and ensuring the
16+
system is reliable and secure. In particular you should ensure you have strong
17+
competency with regards to:
2218

2319
- Hosting
2420
- Traffic routing
@@ -31,8 +27,7 @@ No official support is provided for the open source version of Convex but
3127
community support is available in the `#open-source` channel in the
3228
[Convex Discord](https://discord.gg/convex).
3329

34-
Development of the Convex backend is led by the Convex team and we are not
35-
actively soliciting any major contributions from the community. We of course
30+
Development of the Convex backend is led by the Convex team. We
3631
[welcome bug fixes](./CONTRIBUTING.md) and
3732
[love receiving feedback](https://discord.gg/convex). We keep this repository
3833
synced with any internal development work within a handful of days.

0 commit comments

Comments
 (0)