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

Commit 3452c01

Browse files
committed
Standardized Readme, Add LICENSE
See ipfs/community#124 (comment)
1 parent d9c23d7 commit 3452c01

File tree

2 files changed

+75
-19
lines changed

2 files changed

+75
-19
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2016 Protocol Labs
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
13+
all 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
21+
THE SOFTWARE.

README.md

Lines changed: 54 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,43 @@
11
# IPFS Blog
22

3-
This is the source repository for the [IPFS Blog](http://ipfs.io/blog).
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+
> Source for the [IPFS Blog](http://ipfs.io/blog)
49
510
![](https://www.evernote.com/l/AMaEbN3YfmVC-JDtlxRdFnMMbfvQjQlmU9MB/image.png)
611

7-
## Editing
12+
## Table of Contents
13+
14+
- [Install](#install)
15+
- [Usage](#usage)
16+
- [Creating a Post](#creating-a-post)
17+
- [Live editing](#live-editing)
18+
- [Theme](#theme)
19+
- [Publishing Post](#publishing-post)
20+
- [Editing](#editing)
21+
- [Publishing](#publishing)
22+
- [Contribute](#contribute)
23+
- [Want to hack on IPFS?](#want-to-hack-on-ipfs)
24+
- [License](#license)
825

9-
1. [install node + npm](http://iojs.org) and required modules
26+
## Install
1027

11-
```sh
12-
npm install
13-
```
28+
1. [Install node + npm](http://iojs.org) and required modules.
1429

15-
2. run build
30+
```sh
31+
npm install
32+
```
1633

17-
```sh
18-
node build.js
19-
```
34+
2. Run build.
35+
36+
```sh
37+
node build.js
38+
```
39+
40+
## Usage
2041

2142
### Creating a Post
2243

@@ -39,11 +60,19 @@ make build
3960

4061
This should setup a server. For now, it screws up the styling because the styles are pulled from ipfs directly. (FIXME, should put the styles in the build dir.) Just kill it when you're ready to publish
4162

42-
### Publishing Post
63+
### Theme
4364

44-
How to publish the blog on IPFS.io
65+
The layouts follow [the example viewer](https://github.com/ipfs/examples/tree/master/webapps/example-viewer). Modify the files inside
4566

46-
#### Editing
67+
```
68+
tmpl/
69+
```
70+
71+
## Publishing Post
72+
73+
How to publish the blog on IPFS.io.
74+
75+
### Editing
4776

4877
1. Make a change to a file
4978
2. Add and commit.
@@ -56,7 +85,7 @@ How to publish the blog on IPFS.io
5685
7. Get it merged following review from _another_ member.
5786
8. `$ git checkout master && git pull origin master`
5887

59-
#### Publishing
88+
### Publishing
6089

6190
7. `$ ipfs daemon`
6291
8. `$ make publish`
@@ -71,10 +100,16 @@ How to publish the blog on IPFS.io
71100

72101
You will need access to DigitalOcean for this to work. You will then need to use the token. This will take a few minutes for DNS to propogate.
73102

74-
### Theme
103+
## Contribute
75104

76-
The layouts follow [the example viewer](https://github.com/ipfs/examples/tree/master/webapps/example-viewer). Modify the files inside
105+
Feel free to join in! PRs and [issues](https://github.com/ipfs/blog/issues) are welcome.
77106

78-
```
79-
tmpl/
80-
```
107+
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
108+
109+
### Want to hack on IPFS?
110+
111+
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
112+
113+
## License
114+
115+
MIT (c) Protocol Labs

0 commit comments

Comments
 (0)