Skip to content
This repository was archived by the owner on Jul 5, 2021. It is now read-only.

Commit 37aa84f

Browse files
committed
Standardize README and add License
See ipfs/community#124
1 parent d7df00a commit 37aa84f

File tree

2 files changed

+63
-1
lines changed

2 files changed

+63
-1
lines changed

LICENSE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2016 Protocol Labs, Inc.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
1-
# ipfs.io
1+
# website
2+
3+
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
4+
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
5+
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
6+
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
7+
8+
> ipfs website
9+
10+
## Table of Contents
11+
12+
- [Install](#install)
13+
- [Dependencies](#dependencies)
14+
- [Relative paths](#relative-paths)
15+
- [Site structure](#site-structure)
16+
- [Theme](#theme)
17+
- [Pages content](#pages-content)
18+
- [Blog content](#blog-content)
19+
- [Building the site](#building-the-site)
20+
- [Contribute](#contribute)
21+
- [License](#license)
22+
23+
## Install
24+
25+
Simply clone this repository.
226

327
### Dependencies
428

@@ -8,6 +32,10 @@ This site uses [Pelican](docs.getpelican.com) as a custom configured static site
832

933
You may need to `easy_install pip` if `pip` gives you not found warnings.
1034

35+
## Usage
36+
37+
Open locally in the browser.
38+
1139
## Relative paths
1240

1341
The site is presently built so that all paths are relative, making it easy to deploy to IPFS.
@@ -76,3 +104,15 @@ The site is built via make. Type `make` to see your options.
76104
You can run `./develop_server start` and the site will be automagically rebuilt while you're working on it.
77105

78106
`./develop_server stop` will stop the server
107+
108+
## Contribute
109+
110+
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/website/issues)!
111+
112+
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
113+
114+
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
115+
116+
## License
117+
118+
[MIT](LICENSE)

0 commit comments

Comments
 (0)