From e9e3723c83063431c20086e9f321f5d525271320 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Tue, 7 Feb 2017 14:45:54 -0500 Subject: [PATCH] Add example IPFS README 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 https://github.com/ipfs/community/issues/225#issuecomment-272419143 --- examples/ipfs-README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 examples/ipfs-README.md diff --git a/examples/ipfs-README.md b/examples/ipfs-README.md new file mode 100644 index 00000000..364f4da0 --- /dev/null +++ b/examples/ipfs-README.md @@ -0,0 +1,38 @@ +# + +[![](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) + +> + + + +## Table of Contents + + + +## Install + + + +## Usage + + + +## Maintainers + +Captain: [](https://github.com/). + +## Contribute + +Please contribute! [Look at the issues](https://github.com/ipfs//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.