Skip to content

Commit

Permalink
Add example IPFS README
Browse files Browse the repository at this point in the history
This adds an example IPFS README that conforms to standard-readme and should be able to help with making new READMEs for IPFS repositories. It is language agnostic. However, it is based on a request by the JS team (specifically, @diasdavid) in #225 (comment)
  • Loading branch information
RichardLitt committed Feb 7, 2017
1 parent 607c2f2 commit e9e3723
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions examples/ipfs-README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# <topic>

[![](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)](https://ipfs.io)
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](https://webchat.freenode.net/?channels=%23ipfs)
[![](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

> <description>
<long description>

## Table of Contents

<ToC>

## Install

<install>

## Usage

<usage>

## Maintainers

Captain: [<lead>](https://github.com/<lead>).

## Contribute

Please contribute! [Look at the issues](https://github.com/ipfs/<repo name>/issues)!

Check out our [contributing document](https://github.com/ipfs/ipfs/blob/master/contribute.md) for more information on how we work, and about contributing in general. Please be aware that all interactions related to IPFS are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).

Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.

## License

[MIT](LICENSE) © 2016 Protocol Labs Inc.

0 comments on commit e9e3723

Please sign in to comment.