about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorYuce Tekol <yucetekol@gmail.com>2019-05-03 02:31:01 +0300
committerYuce Tekol <yucetekol@gmail.com>2019-05-03 02:31:01 +0300
commit7fd70619f1fd5651611376f12010b237c3f96ab2 (patch)
treeb1c0c0650cf85786f5928d63a34ea7920204a194
parent83130efe9fbb7a026f571e77b49bb57be45fe5b9 (diff)
downloadpyopenbsd-7fd70619f1fd5651611376f12010b237c3f96ab2.tar.gz
updated readme
-rw-r--r--README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index 71df894..6896dd2 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,8 @@ Python bindings for some OpenBSD-specific APIs. Currently the following are supp
 
 ## Change Log
 
-* **v0.1.0** (2019-05-03)
+### v0.1.0 (2019-05-03)
+
     * Initial release.
 
 ## Installation
@@ -30,7 +31,7 @@ import openbsd
 ### pledge
 
 ```python
-pledge("stdio rpath")
+openbsd.pledge("stdio rpath")
 print(open("/etc/resolv.conf"))
 ```
 
@@ -39,11 +40,14 @@ Try removing `rpath` permission.
 ### unveil
 
 ```python
-unveil("/etc", "r")
+openbsd.unveil("/etc", "r")
 print(open("/etc/resolv.conf"))
 ```
 
-Try reading `/bin/ksh`.
+Try opening `/bin/ksh`.
+
+
+Use `openbsd.unveil()` to stop limiting access to directories.
 
 ## License