JakeHillion/storj
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme (#174)

Browse Source
This commit is contained in:
JT Olio 2018-07-27 10:29:45 -06:00 committed by Philip Hutchins
parent ff52a1e7e1
commit b960d1d55e
1 changed files with 10 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -9,28 +9,22 @@
----
Storj is a platform, token, and suite of decentralized applications that allows you to store data in a secure and decentralized manner. Your files are encrypted, shredded into little pieces called 'shards' and stored in a global decentralized network of computers. Only you have access and the ability to retrieve all shards from the network, decrypt them, and finally re-combine all file pieces into your original file.
Storj is a platform, token, and suite of decentralized applications that allows you to store data in a secure and decentralized manner. Your files are encrypted, shredded into little pieces and stored in a global decentralized network of computers. Luckily, we also support allowing you (and only you) to recover them!
----
## To start using Storj
Storj is in the midst of a rearchitecture. Please stay tuned for our v3 whitepaper!
See our documentation at [Storj docs](https://docs.storj.io/docs).
## To start developing Storj
The [community site](https://storj.io/community.html) hosts all information about building storj from source, how to contribute code
and documentation, who to contact about what, etc.
## To start developing
### Install required packages
First of all install `git`, `golang` and `redis-server` and add environment variables.
First of all, install `git` and `golang`.
#### Debian based (like Ubuntu)
```bash
apt-get install git golang redis-server
apt-get install git golang
echo 'export GOPATH="$HOME/go"' >> $HOME/.bashrc
echo 'export PATH="$PATH:${GOPATH//://bin:}/bin"' >> $HOME/.bashrc
source $HOME/.bashrc
@ -39,7 +33,7 @@ source $HOME/.bashrc
#### Mac OSX
```bash
brew install git go redis
brew install git go
if test -e $HOME/.bash_profile
then
echo 'export GOPATH="$HOME/go"' >> $HOME/.bash_profile
@ -84,27 +78,16 @@ go test storj.io/storj/...
You can execute only a single test package. For example: `go test storj.io/storj/pkg/kademlia`. Add -v for more informations about the executed unit tests.
### Start farmer
### Start the network
```bash
piecestore-farmer --help
go install -v storj.io/storj/cmd/captplanet
captplanet setup
captplanet run
```
To be continued.
## You have a working [Docker environment](https://docs.docker.com/engine).
```
$ git clone https://github.com/storj/storj
$ cd storj
$ make docker
```
For the full story, head over to the [developer's documentation].
## Support
If you need support, start with the [troubleshooting guide], and work your way through the process that we've outlined.
That said, if you have any questions or suggestions please reach out to us on [rocketchat](https://storj.io/community.html) or [twitter](https://twitter.com/storjproject).