Skip to content

Commit 09f63ed

Browse files
committed
State public API status explicitly
[references mbj#65]
1 parent 03dd989 commit 09f63ed

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,20 @@ unparser
99
Generate equivalent source for ASTs from whitequarks [parser](https://github.com/whitequark/parser).
1010
Excluding the macruby extensions the parser gem implemnents on top of ruby syntax.
1111

12-
Excluding the MacRuby / RubyMotion extensions the parser gem implemenents on top of MRI ruby syntax starting with parser release 2.3.
13-
If you feel the need to get them supported, contact me.
12+
Excluding the MacRuby / RubyMotion extensions the parser gem implemenents on top of MRI Ruby
13+
syntax starting with parser release 2.3. If you feel the need to get them supported, contact me.
1414

15-
This library is able to reproduce 100% of ruby 1.9, 2.0 and 2.1 syntax. Including its own source code.
15+
This library is able to reproduce 100% of Ruby 2.1 - 2.3 syntax. Including its own source code.
1616

1717
It serves well for [mutant](https://github.com/mbj/mutant) mutators and the in-memory vendoring for self hosting,
1818
and other tooling.
1919

20+
Public API:
21+
-----------
22+
23+
While unparser is in the `0.x` versions its public API can change any moment. I recommend to use `~> 0.x.y` style
24+
version constraints that should give the best mileage.
25+
2026
Usage
2127
-----
2228

0 commit comments

Comments
 (0)