README

Author: leonardbinet

CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# Contributing to Pandagg
+We want to make contributing to this project as easy and transparent as
+possible.
+
+## Our Development Process
+We use github to host code, to track issues and feature requests, as well as accept pull requests.
+
+
+## Pull Requests
+We actively welcome your pull requests.
+
+1. Fork the repo and create your branch from `master`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints.
+
+## Any contributions you make will be under the MIT Software License
+In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. 
+Feel free to contact the maintainers if that's a concern.
+
+## Issues
+We use GitHub issues to track public bugs. Please ensure your description is
+clear and has sufficient instructions to be able to reproduce the issue.
+
+## Report bugs using Github's [issues](https://github.com/alkemics/pandagg/issues)
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/alkemics/pandagg/issues/new); it's that easy!
+
+## Write bug reports with detail, background, and sample code
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can.
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+
+## License
+By contributing, you agree that your contributions will be licensed under its MIT License.
+
+## References
+This document was adapted from the open-source contribution guidelines of [briandk's gist](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62)

README.md

@@ -0,0 +1,28 @@
+[![PyPI Latest Release](https://img.shields.io/pypi/v/lighttree.svg)](https://pypi.org/project/lighttree/)
+![Python package](https://github.com/leonardbinet/lighttree/workflows/Python%20package/badge.svg)
+
+
+## What is it?
+
+**lighttree** is a Python package providing a simple interface to manipulate data having a tree structure.
+
+
+## Features
+
+- multiple tree update methods
+- ascii display
+- interactive tree with autocompletion feature (for ipython usage)
+
+## Documentation
+
+Full documentation available (work in progress) [here on read-the-docs](https://lighttree.readthedocs.io/en/latest/).
+
+
+## Installation
+```
+pip install lighttree
+```
+
+## Contributing
+
+All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome.