Skip to content

Commit 243d3d6

Browse files
authored
README: Change format, add installation instructions (#44)
2 parents 1e3590d + c67879b commit 243d3d6

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.md renamed to README.rst

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,34 @@
1-
# JSON-minify
1+
JSON-minify
2+
============
23

34
A port of the `JSON-minify` utility to the Python language.
45

5-
## Overview
6+
Overview
7+
--------
68

79
`JSON-minify` minifies blocks of JSON-like content into valid JSON by removing all whitespace *and* JS-style comments (single-line `//` and multiline `/* .. */`).
810

911
With `JSON-minify`, you can maintain developer-friendly JSON documents, but minify them before parsing or transmitting them over-the-wire.
1012

11-
## Testing
12-
To run the tests, just execute json_minify.py, i.e.
13+
Installation
14+
------------
15+
16+
This package is currently not hosted on PyPI. You can install it using pip as follows::
17+
18+
pip install git+https://github.com/getify/JSON.minify@python
19+
20+
21+
Testing
22+
-------
23+
24+
To run the tests, just execute json_minify.py.
25+
26+
::
1327

1428
python json_minify.py
1529

16-
## License
30+
License
31+
-------
1732

1833
The code and all the documentation are released under the MIT license.
1934

0 commit comments

Comments
 (0)