Skip to content

Commit 8460b61

Browse files
authored
Change format, add installation instructions
1 parent 1e3590d commit 8460b61

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md renamed to README.rst

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,33 @@
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
13+
Installation
14+
------------
15+
16+
This package is currently not hosted on PyPI. You can install it using pip as follows:
17+
18+
```
19+
pip install git+https://github.com/getify/JSON.minify@python
20+
```
21+
22+
Testing
23+
-------
24+
1225
To run the tests, just execute json_minify.py, i.e.
1326

1427
python json_minify.py
1528

16-
## License
29+
License
30+
-------
1731

1832
The code and all the documentation are released under the MIT license.
1933

0 commit comments

Comments
 (0)