summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorChris West (Faux) <git@goeswhere.com>2015-10-03 14:48:27 +0100
committerChris West (Faux) <git@goeswhere.com>2015-10-03 14:48:33 +0100
commit56cd4863df5dca720f723dfec503a56d3802242b (patch)
tree83d5cd9fc358a937cb49e4746e02a96413ec6a3d /README.md
parentdf4a67cc17a0709a0312153c583dcd49c16f3147 (diff)
downloadghetto-json-56cd4863df5dca720f723dfec503a56d3802242b.tar.gz
ghetto-json-56cd4863df5dca720f723dfec503a56d3802242b.tar.bz2
ghetto-json-56cd4863df5dca720f723dfec503a56d3802242b.tar.xz
ghetto-json-56cd4863df5dca720f723dfec503a56d3802242b.zip
update README about commentjson support
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9c9c86c..260c314 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,11 @@ ghetto_json lets you make some types of edits to JSON files, and remains simple
it's hopefully easier just to extend than to switch to a different module, and you won't feel
too guilty just copy-pasting it into your codebase.
+If [commentjson](https://pypi.python.org/pypi/commentjson/) is available, it will be used to
+ *read* the file, but comments will be lost on save. This is useful for making edits to default
+ configurations shipped with some applications; where the application itself supports comments in
+ JSON, but they're not required.
+
Installation
------------
@@ -26,6 +31,9 @@ Make in-place changes to simple JSON documents,
Requirements
------------
+[commentjson](https://pypi.python.org/pypi/commentjson/) will be used, if available,
+ but is explictly not required.
+
Python 2.7 may be required for some ``shlex`` functionality
(like working Unicode), which you probably don't care about.