work on readme

fijal · Dec 4, 2014 · 33041e5 · 33041e5
1 parent 1ec8498
commit 33041e5
Showing 1 changed file with 19 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,4 +1,22 @@
 jitpy
 =====
 
-Library to embed PyPy into CPython
+Library to embed PyPy into CPython. See
+[documentation](http://jitpy.readthedocs.org) for more examples.
+
+The simplest example:
+
+    from jitpy.wrapper import jittify
+
+    @jittify([int, float], float)
+    def func(count, no):
+        s = 0
+        for i in range(count):
+           s += no
+        return s
+
+    func(100000000, 1.2)
+
+Runs about 20x faster.
+
+MIT Licensed.