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

Commit

Permalink
Standardize README and add License
Browse files Browse the repository at this point in the history
  • Loading branch information
RichardLitt committed Jun 24, 2016
1 parent d7df00a commit 37aa84f
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 1 deletion.
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
The MIT License (MIT)

Copyright (c) 2016 Protocol Labs, Inc.

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 NONINFRINGEMENT. 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.

42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,28 @@
# ipfs.io
# website

[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

> ipfs website
## Table of Contents

- [Install](#install)
- [Dependencies](#dependencies)
- [Relative paths](#relative-paths)
- [Site structure](#site-structure)
- [Theme](#theme)
- [Pages content](#pages-content)
- [Blog content](#blog-content)
- [Building the site](#building-the-site)
- [Contribute](#contribute)
- [License](#license)

## Install

Simply clone this repository.

### Dependencies

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

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

## Usage

Open locally in the browser.

## Relative paths

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

`./develop_server stop` will stop the server

## Contribute

Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/website/issues)!

This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)

## License

[MIT](LICENSE)

0 comments on commit 37aa84f

Please sign in to comment.