diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..4c29819 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,15 @@ +# .readthedocs.yml +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +mkdocs: + configuration: mkdocs.yml + fail_on_warning: false + +python: + version: 3.7 + install: + - requirements: docs/requirements.txt + +formats: all \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 0a691af..23b9d14 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,3 @@ -# 0.0.0 (YYYY-MM-DD) +# 0.0.0 (2021-06-04) - - TBD + - Initial release. All service providers documented on [docs.defipulse.com](https://web.archive.org/web/20210605215759/https://docs.defipulse.com/) are implemented. diff --git a/endpoints.md b/ENDPOINTS.md similarity index 100% rename from endpoints.md rename to ENDPOINTS.md diff --git a/README.md b/README.md index 79046b8..c495536 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ # Overview +[![PyPI Version](https://img.shields.io/pypi/v/defipulsedata.svg)](https://pypi.org/project/defipulsedata) +[![PyPI License](https://img.shields.io/pypi/l/defipulsedata.svg)](https://pypi.org/project/defipulsedata) +[![Documentation](https://img.shields.io/readthedocs/defipulsedata.svg?logo=read-the-docs)](https://defipulsedata.readthedocs.io/en/latest/) An unofficial Python SDK for the [DeFi Pulse Data](https://docs.defipulse.com/) project and each of its partner service providers. This project provides a lightweight Python @@ -76,7 +79,7 @@ pools.get_exchanges() # Contributing and Filing Issues -Details for local development dependencies and useful Make targets can be found in `contributing.md` +Details for local development dependencies and useful Make targets can be found in [here](https://defipulsedata.readthedocs.io/en/latest/about/contributing/) Contributions, suggestions, bug reports, are welcome and encouraged. diff --git a/README.todo.md b/README.todo.md index df6b71a..760ab31 100644 --- a/README.todo.md +++ b/README.todo.md @@ -7,6 +7,4 @@ This project was generated with [cookiecutter](https://github.com/audreyr/cookie [![Unix Build Status](https://img.shields.io/travis/com/jhhb/pydefipulsedata.svg?label=unix)](https://travis-ci.com/jhhb/pydefipulsedata) [![Windows Build Status](https://img.shields.io/appveyor/ci/jhhb/pydefipulsedata.svg?label=windows)](https://ci.appveyor.com/project/jhhb/pydefipulsedata) [![Coverage Status](https://img.shields.io/coveralls/jhhb/pydefipulsedata.svg)](https://coveralls.io/r/jhhb/pydefipulsedata) -[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/jhhb/pydefipulsedata.svg)](https://scrutinizer-ci.com/g/jhhb/pydefipulsedata) -[![PyPI Version](https://img.shields.io/pypi/v/defipulsedata.svg)](https://pypi.org/project/defipulsedata) -[![PyPI License](https://img.shields.io/pypi/l/defipulsedata.svg)](https://pypi.org/project/defipulsedata) \ No newline at end of file +[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/jhhb/pydefipulsedata.svg)](https://scrutinizer-ci.com/g/jhhb/pydefipulsedata) \ No newline at end of file