summaryrefslogtreecommitdiff
path: root/mkdocs-material/README.md
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2016-07-24 19:13:40 -0400
committerJordan Wiens <jordan@psifertex.com>2016-07-24 19:13:40 -0400
commitb1900d6ebcc39738885f90fa9f18b28206a74947 (patch)
tree2d4975fe0a347af7101200c48e4a8df82ca780ae /mkdocs-material/README.md
parent754ea372c66afad144988fcab2d7cf1fdbb3f2fc (diff)
very early checkin of template for user-docs, only a few pages filled out
Diffstat (limited to 'mkdocs-material/README.md')
-rw-r--r--mkdocs-material/README.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/mkdocs-material/README.md b/mkdocs-material/README.md
new file mode 100644
index 00000000..bf4cd563
--- /dev/null
+++ b/mkdocs-material/README.md
@@ -0,0 +1,54 @@
+# Material
+
+[![Travis CI][travis-image]][travis-link]
+[![PyPI Version][pypi-v-image]][pypi-v-link]
+
+A material design theme for [MkDocs](http://www.mkdocs.org).
+
+[![iOS](docs/images/screen.png)](http://squidfunk.github.io/mkdocs-material/)
+
+## Quick start
+
+Install with `pip`:
+
+``` sh
+pip install mkdocs-material
+```
+
+Add the following line to your `mkdocs.yml`:
+
+``` yaml
+theme: 'material'
+```
+
+For detailed installation instructions and a demo, visit
+http://squidfunk.github.io/mkdocs-material/
+
+## License
+
+**MIT License**
+
+Copyright (c) 2016 Martin Donath
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+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