Skip to content

Commit 231131d

Browse files
committed
Updated README
1 parent 8ab9afe commit 231131d

File tree

2 files changed

+34
-10
lines changed

2 files changed

+34
-10
lines changed

README.md

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# Material
22

3+
[![Travis CI][travis-image]][travis-link]
34
[![PyPI Downloads][pypi-dl-image]][pypi-dl-link]
45
[![PyPI Version][pypi-v-image]][pypi-v-link]
5-
[![Release Status][release-image]][release-link]
6-
[![License][license-image]][license-link]
76

8-
A material design theme for MkDocs.
7+
A material design theme for [MkDocs](http://www.mkdocs.org).
98

10-
![iOS](docs/images/screen.png)
9+
[![iOS](docs/images/screen.png)](http://squidfunk.github.io/mkdocs-material/)
10+
11+
## Quick start
1112

1213
Install with `pip`:
1314

@@ -21,13 +22,35 @@ Add the following line to your `mkdocs.yml`:
2122
theme: 'material'
2223
```
2324
24-
For detailed installation instructions and a demo, visit [squidfunk.github.io/mkdocs-material/](http://squidfunk.github.io/mkdocs-material/)
25+
For detailed installation instructions and a demo, visit
26+
http://squidfunk.github.io/mkdocs-material/
27+
28+
## License
29+
30+
**MIT License**
31+
Copyright (c) 2016 Martin Donath
32+
33+
Permission is hereby granted, free of charge, to any person obtaining a copy
34+
of this software and associated documentation files (the "Software"), to
35+
deal in the Software without restriction, including without limitation the
36+
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
37+
sell copies of the Software, and to permit persons to whom the Software is
38+
furnished to do so, subject to the following conditions:
39+
40+
The above copyright notice and this permission notice shall be included in
41+
all copies or substantial portions of the Software.
42+
43+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
44+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
45+
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
46+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
47+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
48+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
49+
IN THE SOFTWARE.
2550
51+
[travis-image]: https://travis-ci.org/squidfunk/mkdocs-material.svg
52+
[travis-link]: https://travis-ci.org/squidfunk/mkdocs-material
2653
[pypi-dl-image]: https://img.shields.io/pypi/dm/mkdocs-material.png
2754
[pypi-dl-link]: https://pypi.python.org/pypi/mkdocs-material
2855
[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-material.png
29-
[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material
30-
[release-image]: https://img.shields.io/github/release/squidfunk/mkdocs-material.svg
31-
[release-link]: https://github.com/squidfunk/mkdocs-material/releases/latest
32-
[license-image]: https://img.shields.io/github/license/squidfunk/mkdocs-material.svg
33-
[license-link]: https://github.com/squidfunk/mkdocs-material/blob/master/LICENSE
56+
[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material

docs/license.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# License
22

3+
**MIT License**
34
Copyright (c) 2016 Martin Donath
45

56
Permission is hereby granted, free of charge, to any person obtaining a copy

0 commit comments

Comments
 (0)