1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..71df894
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# openbsd
+
+Python bindings for some OpenBSD-specific APIs. Currently the following are supported:
+* `pledge`
+* `unveil`
+
+## Change Log
+
+* **v0.1.0** (2019-05-03)
+    * Initial release.
+
+## Installation
+
+Openbsd is on PyPI. You can install it using pip:
+
+    pip install openbsd
+
+### Prerequisites
+
+* OpenBSD 6.4 or better
+* Python 3.6 or better OR Python 2.7
+
+## Usage
+
+Import `openbsd` first:
+```python
+import openbsd
+```
+
+### pledge
+
+```python
+pledge("stdio rpath")
+print(open("/etc/resolv.conf"))
+```
+
+Try removing `rpath` permission.
+
+### unveil
+
+```python
+unveil("/etc", "r")
+print(open("/etc/resolv.conf"))
+```
+
+Try reading `/bin/ksh`.
+
+## License
+
+(c) 2019 Yuce Tekol
+
+[BSD](LICENSE)