From 56cd4863df5dca720f723dfec503a56d3802242b Mon Sep 17 00:00:00 2001 From: "Chris West (Faux)" Date: Sat, 3 Oct 2015 14:48:27 +0100 Subject: update README about commentjson support --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) 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. -- cgit v1.2.3