Update README.md

ken-morel · May 3, 2024 · f572723 · f572723
1 parent 7c27820
commit f572723
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -6,3 +6,17 @@
 [![Build Status](https://github.com/ken-morel/pyoload/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/ken-morel/pyoload/tree/main)
 [![Coverage Status](https://coveralls.io/repos/github/ken-morel/pyoload/badge.svg?branch=main)](https://coveralls.io/github/ken-morel/pyoload?branch=main)
 
+pyoload has two main functions
+
+annotate
+========
+```python
+
+from pyoload import annotate
+
+@annotate
+def twice(a:int) -> int:
+    return a * 2
+
+b = twice(4)
+```