Update doc (#212)

* Update doc

AUTHORS

@@ -1,5 +1,10 @@
-Brett Alistair Kromkamp - [email protected]
-Xiaming Chen - [email protected]
-Holger Bast - [email protected]
+# Contributors
 
-and other committers etc.
+* Brett Alistair Kromkamp ([email protected]): Post basic idea online.
+* Xiaming Chen ([email protected]): Finished primary parts and made the library freely public.
+* Holger Bast ([email protected]): Replaced list with `dict` for fast node index and optimized the performance.
+* Ilya Kuprik ([email protected]): Added ZIGZAG tree-walk algorithm to tree traversal.
+
+and other committers etc.
+
+Thank you all.

HISTORY

@@ -1,9 +1,17 @@
-Mar 27 2023 V1.6.3
+# History
+
+Mar 27, 2023 V1.6.3
 Apply to black code style. Migrate future to six
 
-Oct 13 2019 V1.5.6
+
+Oct 13, 2019 V1.5.6
 Add ability to independently mutate multiple shallow copies of same initial tree.
 
+
+Aug 10, 2017 V1.4.0
+Abandon supporting Python 3.2 since v1.4.0.
+
+
 Mar 27, 2014 V1.2.6
 Node identifier supports multiple data types beyond int and str.
 Finish depth() and leaves() routines.

README.md

@@ -1,5 +1,4 @@
-treelib
--------
+# treelib
 
 Tree implementation in python: simple for you to use.
 
@@ -16,38 +15,24 @@ Tree implementation in python: simple for you to use.
 [![GitHub pull-requests](https://img.shields.io/github/issues-pr/caesar0301/treelib.svg)](https://GitHub.com/caesar0301/treelib/pulls)
 [![GitHub pull-requests closed](https://img.shields.io/github/issues-pr-closed/caesar0301/treelib.svg)](https://GitHub.com/caesar0301/treelib/pulls?q=is%3Apr+is%3Aclosed)
 
+## Quick Start
 
+    pip install -U treelib
 
-
-Quick Start
------------
-
-    sudo easy_install -U treelib
-
-install with pip by pip install treelib
-
-Documentation
--------------
+## Documentation
 
 For installation, APIs and examples, see http://treelib.readthedocs.io/en/latest/
 
-Update
--------
+## Code Style
 
-* 2017-08-10: Abandon supporting Python 3.2 since v1.4.0.
-* 2012-07-07: First published.
+`treelib` complies with [black](https://github.com/psf/black) formatter and
+specific [flake8 validations](https://github.com/caesar0301/treelib/blob/master/scripts/flake8.sh).
+Before creating a pull request, please make sure you pass the local validation
+with `scripts/flake8.sh`.
 
+## Contributors
 
-Contributors
-------------
-
-> Brett Alistair Kromkamp ([email protected]): Post basic idea online.
->
-> Xiaming Chen ([email protected]): Finished primary parts and made the library freely public.
->
-> Holger Bast ([email protected]): Replaced list with `dict` for fast node index and optimized the performance.
->
-> Ilya Kuprik ([email protected]): Added ZIGZAG tree-walk algorithm to tree traversal.
+Thank you all,
+[committers](https://github.com/caesar0301/treelib/graphs/contributors).
 
 [![ForTheBadge built-with-love](http://ForTheBadge.com/images/badges/built-with-love.svg)](https://GitHub.com/Naereen/)
-