diff --git a/CHANGELOG.md b/CHANGELOG.md index 3e5aa2f..4653e7e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,12 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] -### Changed -- Adapted bizstyle theme with a new stylesheet. - +## [1.0.0] - 2020-12-20 +### Changed +- Adapted bizstyle theme with a new stylesheet. - - \ No newline at end of file +[Unreleased]: https://github.com/miaowware/miaowware_sphinx_theme/compare/1.0.0...HEAD +[1.0.0]: https://github.com/miaowware/miaowware_sphinx_theme/releases/tag/1.0.0 \ No newline at end of file diff --git a/README.md b/README.md index ad1fa61..66b9bc2 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,9 @@ This theme is used for sphinx documentation of Miaowware projects. ## Usage +Install with `pip install -e https://github.com/miaowware/miaowware-sphinx-theme.git`, +or add `-e https://github.com/miaowware/miaowware-sphinx-theme.git` to your sphinx `requirements.txt`. + In your sphinx `conf.py`, add: ```py