diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..55a2d036b --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2016 Protocol Labs + +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 dffc5c225..c907ce84e 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,47 @@ # IPFS Blog -This is the source repository for the [IPFS Blog](http://ipfs.io/blog). +[![](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) + +> Source for the [IPFS Blog](http://ipfs.io/blog) ![](https://www.evernote.com/l/AMaEbN3YfmVC-JDtlxRdFnMMbfvQjQlmU9MB/image.png) #### Please Review [PIPELINE.md](./PIPELINE.md) to understand how this repo pipeline works. +## Table of Contents + +- [Install](#install) +- [Usage](#usage) + - [Creating a Post](#creating-a-post) + - [Live editing](#live-editing) + - [Theme](#theme) +- [Publishing Post](#publishing-post) + - [Editing](#editing) + - [Publishing](#publishing) +- [Contribute](#contribute) + - [Want to hack on IPFS?](#want-to-hack-on-ipfs) +- [License](#license) + ## Editing -1. [install node + npm](http://iojs.org) and required modules +## Install - ```sh - npm install - ``` +1. [Install node + npm](http://iojs.org) and required modules. -2. run build +```sh +npm install +``` - ```sh - node build.js - ``` +2. Run build. + +```sh +node build.js +``` + +## Usage ### Creating a Post @@ -47,11 +70,19 @@ make build 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 -### Publishing Post +### Theme + +The layouts follow [the example viewer](https://github.com/ipfs/examples/tree/master/webapps/example-viewer). Modify the files inside + +``` +tmpl/ +``` + +## Publishing Post -How to publish the blog on IPFS.io +How to publish the blog on IPFS.io. -#### Editing +### Editing 1. Make a change to a file 2. Add and commit. @@ -64,7 +95,7 @@ How to publish the blog on IPFS.io 7. Get it merged following review from _another_ member. 8. `$ git checkout master && git pull origin master` -#### Publishing +### Publishing 7. `$ ipfs daemon` 8. `$ make publish` @@ -79,10 +110,16 @@ How to publish the blog on IPFS.io 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. -### Theme +## Contribute -The layouts follow [the example viewer](https://github.com/ipfs/examples/tree/master/webapps/example-viewer). Modify the files inside +Feel free to join in! PRs and [issues](https://github.com/ipfs/blog/issues) are welcome. -``` -tmpl/ -``` +This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). + +### Want to hack on IPFS? + +[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md) + +## License + +MIT (c) Protocol Labs