From babb841e1470ee850ab38fa6ca84d321f1ff356b Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Fri, 24 Jun 2016 18:27:24 +0100 Subject: [PATCH] Standardize README See ipfs/community#124 --- LICENSE | 22 ++++++++++++++++++++++ README.md | 34 ++++++++++++++++++++++++++++------ 2 files changed, 50 insertions(+), 6 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..2b7661ee4 --- /dev/null +++ b/LICENSE @@ -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. + diff --git a/README.md b/README.md index f4fc46724..03d676765 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,20 @@ -# Station +# station -[![](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) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/ipfs/station) +[![](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) +[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/ipfs/station) +[![Build Status](https://img.shields.io/travis/ipfs/station/master.svg?style=flat-square)](https://travis-ci.org/ipfs/station) +[![Dependency Status](https://img.shields.io/david/ipfs/station.svg?style=flat-square)](https://david-dm.org/ipfs/station) +[![devDependency Status](https://img.shields.io/david/dev/ipfs/station.svg?style=flat-square)](https://david-dm.org/ipfs/station#info=devDependencies) -[![Build Status](https://img.shields.io/travis/ipfs/station/master.svg?style=flat-square)](https://travis-ci.org/ipfs/station) [![Dependency Status](https://img.shields.io/david/ipfs/station.svg?style=flat-square)](https://david-dm.org/ipfs/station) [![devDependency Status](https://img.shields.io/david/dev/ipfs/station.svg?style=flat-square)](https://david-dm.org/ipfs/station#info=devDependencies) +> Electron Shell based IPFS app -> A Native Application for your OS to run your own IPFS Node. Built with [Electron](http://electron.atom.io/). +A Native Application for your OS to run your own IPFS Node. Built with [Electron](http://electron.atom.io/). -## Development -## Setup +## Install You will need [Node.js](https://nodejs.org/en/) installed. Preferrably a version `>=4.0`. Also you will need [npm](npmjs.org) `>=3.0`. After that you should run @@ -22,3 +28,19 @@ $ npm start This launches the app and runs it in your menu bar. Click the IPFS icon to open a console. For example (in OSX): ![](https://ipfs.io/ipfs/QmaufMhYVWPKwhC1jSb4qHBxgiahrq9ct2hgqk5cZxeE7s) + +## Usage + +See [Install](#install). + +## Contribute + +Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/station/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)