summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorPrashanth Pai <ppai@redhat.com>2016-06-10 15:47:47 +0530
committerPrashanth Pai <ppai@redhat.com>2016-06-10 15:47:47 +0530
commit759471ddcd76306b952bb2ee28f211afc9e24f3a (patch)
tree74234f6dbc010fa436c2f2f9387169ceedabd38e /README.md
parent2de0f31c04b588098eaaabe8dc19b961bfd83d0b (diff)
Improve sphinx rendering on RTD
Change-Id: I646b5d26bca6d4f0123c1b2140f80f24d268568e Signed-off-by: Prashanth Pai <ppai@redhat.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 0 insertions, 38 deletions
diff --git a/README.md b/README.md
index aadbcb1..1fa9fba 100644
--- a/README.md
+++ b/README.md
@@ -6,44 +6,6 @@ This is the official python bindings for the
Complete API reference and documentation can be found at
[ReadTheDocs](http://libgfapi-python.readthedocs.io/)
-### Installation
-
-```
-$ git clone https://review.gluster.org/libgfapi-python
-$ cd libgfapi-python
-$ sudo python setup.py install
-```
-
-### Example Usage
-
-```python
-from gluster import gfapi
-
-# Create virtual mount
-volume = gfapi.Volume('10.7.1.99', 'datavolume')
-volume.mount()
-
-# Create directory
-volume.mkdir('dir1', 0755)
-
-# List directories
-volume.listdir('/')
-
-# Create new file and write to it
-with volume.fopen('somefile.txt', 'w+') as f:
- f.write("Winter is coming.")
-
-# Open and read file
-with volume.fopen('somefile.txt', 'r') as f:
- print f.read()
-
-# Delete file
-volume.unlink('somefile.txt')
-
-# Unmount the volume
-volume.umount()
-```
-
### TODOs
* Submit to pypy to enable installing using pip