release 1.0.0

miaowware · Dec 20, 2020 · 3e16b6d · 3e16b6d
1 parent 8acb5e7
commit 3e16b6d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git 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] - YYYY-MM-DD -->
+## [1.0.0] - 2020-12-20
+### Changed
+- Adapted bizstyle theme with a new stylesheet.
 
 
-<!-- [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 -->
+[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
diff --git 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