You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-6Lines changed: 11 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -8,12 +8,16 @@ This is a port of the [Typesafe Config](https://github.com/typesafehub/config) l
8
8
The library provides Ruby support for the [HOCON](https://github.com/typesafehub/config/blob/master/HOCON.md) configuration file format.
9
9
10
10
11
-
At present, it supports supports parsing and modification of existing HOCON/JSON files via the `ConfigFactory` class and the `ConfigValueFactory` class, and rendering parsed config objects back to a String.
12
-
It also supports the parsing and modification of HOCON/JSON files via `ConfigDocumentFactory`.
13
-
PLEASE NOTE this project is in an experimental state, and in some cases may not work properly, so
14
-
please be wary when using it. If you find a problem, feel free to open a github issue.
11
+
At present, it supports supports parsing and modification of existing HOCON/JSON files via the `ConfigFactory`
12
+
class and the `ConfigValueFactory` class, and rendering parsed config objects back to a String
13
+
([see examples below](#basic-usage)). It also supports the parsing and modification of HOCON/JSON files via
14
+
`ConfigDocumentFactory`.
15
15
16
-
The implementation is intended to be as close to a line-for-line port as the two languages allow, in hopes of making it fairly easy to port over new changesets from the Java code base over time.
16
+
**Note:** While the project is production ready, since not all features in the Typesafe library are supported,
17
+
you may still run into some issues. If you find a problem, feel free to open a github issue.
18
+
19
+
The implementation is intended to be as close to a line-for-line port as the two languages allow,
20
+
in hopes of making it fairly easy to port over new changesets from the Java code base over time.
17
21
18
22
Basic Usage
19
23
===========
@@ -64,7 +68,8 @@ bundle exec rspec spec
64
68
Unsupported Features
65
69
====================
66
70
67
-
This supports many of the same things as the Java library, but there are some notable exceptions. Unsupported features include:
71
+
This supports many of the same things as the Java library, but there are some notable exceptions.
0 commit comments