From fe7ea88d6a5d46e287ee257f63bc8582157e6c1f Mon Sep 17 00:00:00 2001 From: Enrico Fasoli Date: Fri, 4 Dec 2015 11:07:19 +0100 Subject: [PATCH] fix #38 and other docs changes --- HACKING.md => CONTRIBUTING.md | 4 ++++ LICENSE | 21 +++++++++++++++++++++ README.md | 18 +++++++++++++++--- 3 files changed, 40 insertions(+), 3 deletions(-) rename HACKING.md => CONTRIBUTING.md (92%) create mode 100644 LICENSE diff --git a/HACKING.md b/CONTRIBUTING.md similarity index 92% rename from HACKING.md rename to CONTRIBUTING.md index 04790a7..59d91e5 100644 --- a/HACKING.md +++ b/CONTRIBUTING.md @@ -20,3 +20,7 @@ Now you can run: - `gulp serve` to start a webserver that will serve you the app and rebuild it if you change some files Have fun! + +### Contributing a pull request + +Make sure your code compiles fine :) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..565d980 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2015 Enrico Fasoli (fazo96) + +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 80594c6..1831801 100644 --- a/README.md +++ b/README.md @@ -45,9 +45,21 @@ architecture or, optionally, none of these! The App is not ready yet, but you're welcome to take a look at the prototype, even though it only has informational pages and very limited functionality. -You can access it [here](http://ipfs.io/ipfs/QmPmqUP5bYUme6V45n4BzPTp6BM1wwX2nGsh5ttpC5qg1C) +Also keep in mind that due to issues with the current implementation of IPNS in +go-ipfs, real world usage of the prototype is very limited. This will all be +sorted out as soon as go-ipfs' next version, 0.4, is out. -### Prototype information +You can take a look at the prototype [here](http://ipfs.io/ipfs/QmPmqUP5bYUme6V45n4BzPTp6BM1wwX2nGsh5ttpC5qg1C) +but you won't be able to actually use it. + +If you want to really use the prototype, you can quickly set up your machine like this: + +1. get `go-ipfs` installed on your OSX or GNU/Linux system +1. run this in a terminal `API_ORIGIN="localhost:8080" ipfs daemon` +1. open [this](http://localhost:8080/ipfs/QmPmqUP5bYUme6V45n4BzPTp6BM1wwX2nGsh5ttpC5qg1C) in your browser +1. You're all set! + +### Additional information You need a local instance of go-ipfs running for it to work. You also need to set CORS settings right or it won't work. However, in that case, it will complain to @@ -80,7 +92,7 @@ See `PROTOCOL.md` ### How do I set up a development environment? -See `HACKING.md` +See `CONTRIBUTING.md` ## Components