Skip to content

Commit 287bde6

Browse files
committed
Update project status to reflect reality
It *is* pre-1.0 and it *does* occasionally have backwards-incompatible changes, but they are well documented with clear upgrade paths, and not happening at a breakneck pace. For example, with the introduction of unpack, the |-operator is deprecated, but it still works. Or take the assertion syntax: it changed, but the old syntax is still accepted, and the autoformatter automatically upgrades documents. So I think that the previous phrase was a bit too conservative. Other "mature" projects cause me breakage headaches far more often than RCL. The readme should reflect that.
1 parent a81e470 commit 287bde6

File tree

3 files changed

+12
-13
lines changed

3 files changed

+12
-13
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,10 +123,10 @@ target/release/rcl fmt examples/tags.rcl
123123

124124
## Status
125125

126-
RCL is a hobby project without stability promise. It is usable and useful,
127-
well-tested, and well-documented, but also still experimental, and it may have
128-
breaking changes. Syntax highlighting is available for major editors like Vim,
129-
Emacs, Helix, and Zed.
126+
RCL is usable and useful, well-tested, and well-documented. It is still pre-1.0,
127+
though backwards-incompatible changes have been rare in the past years. Syntax
128+
highlighting is available for major editors like Vim, Emacs, Helix, and Zed.
129+
RCL is a community project without commercial support.
130130

131131
## Support RCL
132132

docs/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ For an interactive demo in your browser, see <https://rcl-lang.org>.
5151

5252
## Status
5353

54-
RCL is a hobby project without stability promise. It is usable and useful,
55-
well-tested, and well-documented, but also still experimental, and it may have
56-
breaking changes. Syntax highlighting is available for major editors like Vim,
57-
Emacs, Helix, and Zed.
54+
RCL is usable and useful, well-tested, and well-documented. It is still pre-1.0,
55+
though backwards-incompatible changes have been rare in the past years. Syntax
56+
highlighting is available for major editors like Vim, Emacs, Helix, and Zed.
57+
RCL is a community project without commercial support.
5858

5959
## License
6060

website/index.html

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -614,11 +614,10 @@ <h2><a href="#get-in-touch" id="get-in-touch">Get in touch</a></h2>
614614
</div>
615615
<div class="feature-block span-r2">
616616
<h2><a href="#status" id="status">Status</a></h2>
617-
<p>RCL is a hobby project without stability promise.
618-
It is usable and useful, well-tested, and well-documented,
619-
but also still experimental, and it may have breaking changes.
620-
Syntax highlighting is available for major editors
621-
like Vim, Emacs, Helix, and Zed.
617+
<p>RCL is usable and useful, well-tested, and well-documented. It is still
618+
pre-1.0, though backwards-incompatible changes have been rare in the past
619+
years. Syntax highlighting is available for major editors like Vim, Emacs,
620+
Helix, and Zed. RCL is a community project without commercial support.
622621
</p>
623622
</div>
624623
<div class="span-full">

0 commit comments

Comments
 (0)