First published version 🎉

mre · Nov 19, 2018 · 3a96b9a · 3a96b9a
1 parent 82749f5
commit 3a96b9a
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/Makefile b/Makefile
@@ -24,6 +24,10 @@ nightly: ## Set rust compiler to nightly version
 install: nightly dev-packages ## Install hyperjson module into current virtualenv
 	pipenv run pyo3-pack develop
 
+.PHONY: publish
+publish: ## Publish crate on Pypi
+	pipenv run pyo3-pack publish
+
 .PHONY: clean
 clean: ## Clean up build artifacts
 	pipenv --rm || true

diff --git a/README.md b/README.md
@@ -8,11 +8,18 @@ drop-in replacement for Python's built-in
 around Rust's [serde-json](https://github.com/serde-rs/json) built with
 [pyo3](https://github.com/PyO3/pyo3). Compatible with Python 3 and 2 (not officially supported). This is alpha software and there will be bugs, so maybe don't deploy to production *just* yet. :wink:
 
+## Installation
+
+```
+pip install hyperjson
+```
+
 ## Usage
 
 hyperjson is meant as a drop-in replacement for Python's [json
 module](https://docs.python.org/3/library/json.html):  
 
+
 ```python
 >>> import hyperjson 
 >>> hyperjson.dumps([{"key": "value"}, 81, True])