Skip to content

Commit bad035e

Browse files
committed
Standardize README and add License
See ipfs/community#124
1 parent 8437893 commit bad035e

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,22 @@
1-
Specifications
2-
==============
1+
# Specifications
2+
3+
![](media-artifacts/ipfs-splash.png)
34

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

8-
![](media-artifacts/ipfs-splash.png)
10+
> This repository contains the specs for the IPFS Protocol and associated subsystems.
11+
12+
Some day we will hopefully transform these specs into RFCs. For now, they assume a high level of familiarity with the concepts.
13+
14+
## Table of Contents
915

10-
> This repository contains the specs for the IPFS Protocol and associated subsystems. Some day we will hopefully transform these specs into RFCs. For now, they assume a high level of familiarity with the concepts.
16+
- [Work In Progress](#work-in-progress)
17+
- [Specs](#specs)
18+
- [Contribute](#contribute)
19+
- [License](#license)
1120

1221
## Work In Progress
1322

@@ -82,8 +91,18 @@ The specs contained in this repository are:
8291
**Other/related/included:**
8392
- [PDD](/pdd-protocol-driven-development) - Protocol Driven Development
8493

85-
## Collaborating
94+
## Contribute
8695

8796
Suggestions, contributions, criticisms are welcome. Though please make sure to familiarize yourself deeply with IPFS, the models it adopts, and the principles it follows.
8897

8998
Please be aware that specs are really hard to design by committee. Treat this space like you would the workshop of an artist. Please suggest improvements, but please don't be disappointed if we say no to something. What we leave out is often more important than what we add in.
99+
100+
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/specs/issues)!
101+
102+
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
103+
104+
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
105+
106+
## License
107+
108+
TBD. See https://github.com/ipfs/specs/issues/137.

0 commit comments

Comments
 (0)