Improve README and bump version

CHANGELOG.md

@@ -1,6 +1,12 @@
-# flat-tree 0.0.1a7 (UNRELEASED)
+# flat-tree 0.0.1a8 (UNRELEASED)
 
-# flat-tree 0.0.1a6 2020-07-07
+# flat-tree 0.0.1a7 (2020-07-07)
+
+## Improved Documentation
+
+- Made README clearer and added example
+
+# flat-tree 0.0.1a6 (2020-07-07)
 
 ## Trivial/Internal Changes
 

README.md

@@ -4,10 +4,6 @@
 
 ## Utilities for navigating flat trees
 
-```sh
-$ pip install flat-tree
-```
-
 > Flat Trees are the core data structure that power Hypercore feeds. They allow
 > us to deterministically represent a tree structure as a vector. This is
 > particularly useful because vectors map elegantly to disk and memory. Because
@@ -15,3 +11,19 @@ $ pip install flat-tree
 > them. In effect this means that Flat Trees are a specific way of indexing
 > into a vector more than they are their own data structure. This makes them
 > uniquely efficient and convenient to implement in a wide range of languages.
+
+## Install
+
+```
+$ pip install flat-tree
+```
+
+## Example
+
+```
+>>> from flat_tree.accessor import FlatTreeIterator
+>>> tree_iter = FlatTreeIterator()
+>>> assert tree_iter.index == 0
+>>> assert tree_iter.parent() == 1
+>>> assert tree_iter.parent() == 3
+```

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "flat-tree"
-version = "0.0.1a6"
+version = "0.0.1a7"
 description = "Utilities for navigating flat trees"
 authors = ["Decentral1se <hi@decentral1.se>"]
 maintainers = ["Decentral1se <hi@decentral1.se>"]