From f95c309462308434d3d4927f57aa05d4ad5e00eb Mon Sep 17 00:00:00 2001 From: Havoc Pennington Date: Tue, 6 Dec 2011 00:12:44 -0500 Subject: [PATCH] add a couple of minor notes to the README about sbt and Java properties --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index ca2c6d51..87d70177 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,12 @@ copyrighted material via pull request, email, or other means you agree to license your the material under the Apache 2.0 license and warrant that you have the legal authority to do so. +## Build + +The build uses sbt and the tests are written in Scala; however, +the library itself is plain Java and the published jar has no +Scala dependency. + ## API Example Config conf = ConfigFactory.load(); @@ -159,6 +165,8 @@ detail. ### Examples of HOCON +All of these are valid HOCON. + Start with valid JSON: { @@ -209,6 +217,12 @@ The syntax is well-defined (including handling of whitespace and escaping). But it handles many reasonable ways you might want to format the file. +Note that while you can write HOCON that looks a lot like a Java +properties file (and many properties files will parse as HOCON), +the details of escaping, whitespace handling, comments, and so +forth are more like JSON. The spec (see HOCON.md in this +directory) has some more detailed notes on this topic. + ### Uses of Substitutions The `${foo.bar}` substitution feature lets you avoid cut-and-paste