1
0
mirror of https://github.com/fazo96/ipfs-boards synced 2025-01-24 14:44:19 +01:00

fix #38 and other docs changes

This commit is contained in:
Enrico Fasoli 2015-12-04 11:07:19 +01:00
parent 7608757891
commit fe7ea88d6a
3 changed files with 40 additions and 3 deletions

View File

@ -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 :)

21
LICENSE Normal file
View File

@ -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.

View File

@ -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