From 231131d76fb1a56e705b9b57fe33c8c3c1690fc7 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Thu, 11 Feb 2016 12:33:28 +0100 Subject: [PATCH] Updated README --- README.md | 43 +++++++++++++++++++++++++++++++++---------- docs/license.md | 1 + 2 files changed, 34 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index c77ecc4c8..d34a63bed 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@ # Material +[![Travis CI][travis-image]][travis-link] [![PyPI Downloads][pypi-dl-image]][pypi-dl-link] [![PyPI Version][pypi-v-image]][pypi-v-link] -[![Release Status][release-image]][release-link] -[![License][license-image]][license-link] -A material design theme for MkDocs. +A material design theme for [MkDocs](http://www.mkdocs.org). -![iOS](docs/images/screen.png) +[![iOS](docs/images/screen.png)](http://squidfunk.github.io/mkdocs-material/) + +## Quick start Install with `pip`: @@ -21,13 +22,35 @@ Add the following line to your `mkdocs.yml`: theme: 'material' ``` -For detailed installation instructions and a demo, visit [squidfunk.github.io/mkdocs-material/](http://squidfunk.github.io/mkdocs-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-dl-image]: https://img.shields.io/pypi/dm/mkdocs-material.png [pypi-dl-link]: https://pypi.python.org/pypi/mkdocs-material [pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-material.png -[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material -[release-image]: https://img.shields.io/github/release/squidfunk/mkdocs-material.svg -[release-link]: https://github.com/squidfunk/mkdocs-material/releases/latest -[license-image]: https://img.shields.io/github/license/squidfunk/mkdocs-material.svg -[license-link]: https://github.com/squidfunk/mkdocs-material/blob/master/LICENSE \ No newline at end of file +[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material \ No newline at end of file diff --git a/docs/license.md b/docs/license.md index 7830c45f4..01ce921bb 100644 --- a/docs/license.md +++ b/docs/license.md @@ -1,5 +1,6 @@ # License +**MIT License** Copyright (c) 2016 Martin Donath Permission is hereby granted, free of charge, to any person obtaining a copy