Merge pull request #8 from sspreitzer/documentclass

Add documentation
sspreitzer · Jun 3, 2015 · 3c3bc43 · 3c3bc43
2 parents 180f52b + f28eeb2
commit 3c3bc43
Showing 1 changed file with 26 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -2,9 +2,33 @@
 
 Python library to convert Windows SIDs
 
-## TODO
+## Example
 
-* Documentation in README.md
+String input
+```python
+import sid
+
+mysid = sid.sid('S-1-5-21-2127521184-1604012920-1887927527-72713')
+print mysid.base64()
+```
+
+Output
+```
+AQUAAAAAAAUVAAAAoGXPfnhLm1/nfIdwCRwBAA==
+```
+
+Base46 input
+```python
+import sid
+
+mysid = sid.sid('AQUAAAAAAAUVAAAAoGXPfnhLm1/nfIdwCRwBAA==', sid.SID_BASE64)
+print mysid
+```
+
+Output
+```
+S-1-5-21-2127521184-1604012920-1887927527-72713
+```
 
 ## Changelog
 * 0.1