From e21949edc52fcc121281fedc2ca7c550ef484ea4 Mon Sep 17 00:00:00 2001 From: Martin Donath Date: Tue, 20 Sep 2016 09:27:42 +0200 Subject: [PATCH] Update README.md --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bf4cd5635..dc4bc99a8 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,13 @@ A material design theme for [MkDocs](http://www.mkdocs.org). +**Note: the theme is currently undergoing a complete rewrite for 1.0.0 which should be +released shortly.** + +* To get a glimpse, checkout the +[rework](https://github.com/squidfunk/mkdocs-material/tree/rework) branch +* To give feedback on the rework version, please see issues [#46](https://github.com/squidfunk/mkdocs-material/issues/46) + [![iOS](docs/images/screen.png)](http://squidfunk.github.io/mkdocs-material/) ## Quick start @@ -51,4 +58,4 @@ IN THE SOFTWARE. [travis-image]: https://travis-ci.org/squidfunk/mkdocs-material.svg [travis-link]: https://travis-ci.org/squidfunk/mkdocs-material [pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-material.png -[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material \ No newline at end of file +[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material