👌 IMPROVE: setup file, version and README (#9)

* updated README and version

* added badges

Author: AakashGfude

README.md

@@ -1,3 +1,33 @@
-# sphinx-multitoc-numbering
+# sphinx-parttoc-numbering
 
-A Sphinx extension to support continuous numbering of sections across multiple tocs in HTML output.
+[![Github-CI][github-ci]][github-link]
+[![Coverage Status][codecov-badge]][codecov-link]
+
+**A Sphinx extension to support continuous numbering of sections across multiple tocs in HTML output**.
+
+This package contains a [Sphinx](http://www.sphinx-doc.org/en/master/) extension to continuously number sections across multiple toctrees present in the same document. Also quite useful in [jupyter-book](https://jupyterbook.org/) projects for continuous numbering of chapters across different parts.
+
+## Get started
+
+To get started with `sphinx-multitoc-numbering`, first install it through `pip`:
+
+```
+pip install sphinx-multitoc-numbering
+```
+
+then, add `sphinx_multitoc_numbering` to your sphinx `extensions` in the `conf.py`
+
+```python
+...
+extensions = ["sphinx_multitoc_numbering"]
+...
+```
+
+## Contributing
+
+We welcome all contributions! See the [EBP Contributing Guide](https://executablebooks.org/en/latest/contributing.html) for general details.
+
+[github-ci]: https://github.com/executablebooks/sphinx-multitoc-numbering/workflows/continuous-integration/badge.svg?branch=master
+[github-link]: https://github.com/executablebooks/sphinx-multitoc-numbering
+[codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-multitoc-numbering/branch/master/graph/badge.svg
+[codecov-link]: https://codecov.io/gh/executablebooks/sphinx-multitoc-numbering

setup.py

@@ -15,7 +15,7 @@
     long_description_content_type="text/markdown",
     packages=find_packages(),
     license="MIT",
-    install_requires=["sphinx"],
+    install_requires=["sphinx>=3"],
     extras_require={
         "code_style": ["flake8<3.8.0,>=3.7.0", "black", "pre-commit==1.17.0"],
         "testing": [

sphinx_multitoc_numbering/__init__.py

@@ -18,7 +18,7 @@
 
 logger = logging.getLogger(__name__)
 
-__version__ = "0.0.1"
+__version__ = "0.1.0"
 """sphinx-multitoc-numbering version"""