From 64bb08d65998f3e6e18c36450c34bb21c383dc64 Mon Sep 17 00:00:00 2001
From: Lucas Theis <lucas@theis.io>
Date: Thu, 3 Oct 2019 21:15:16 +0100
Subject: [PATCH] add readme with example

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..56da9e7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+Installation
+============
+
+	pip install range-coder
+
+
+Example
+=======
+
+```python
+from range_coder import RangeEncoder, RangeDecoder, prob_to_cum_freq
+
+data = [2, 0, 1, 0, 0, 0, 1, 2, 2]
+prob = [0.5, 0.2, 0.3]
+
+# convert probabilities to cumulative integer frequency table
+cumFreq = prob_to_cum_freq(prob, resolution=128)
+
+# encode data
+encoder = RangeEncoder(filepath)
+encoder.encode(data, cumFreq)
+encoder.close()
+
+# decode data
+decoder = RangeDecoder(filepath)
+dataRec = decoder.decode(len(data), cumFreq)
+decoder.close()
+```