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

Read me updates (#215)

Browse Source 
* Read me updates

Readme updates based off the first two rounds of critic reviews

* Update README.md

* Update README.md
This commit is contained in:
Brandon Iglesias 2018-08-10 11:28:38 -04:00 committed by nfarah86
parent ffaebb57df
commit 73a0bf3c7b
1 changed files with 69 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

93
README.md
View File

@ -12,14 +12,75 @@ Storj is in the midst of a rearchitecture. Please stay tuned for our v3 whitepap
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 developing
# Start Using Storj
### Download the latest release
Go here to download the latest build
// TODO: add link when a build is released
// TODO for how to run the release
### Configure AWS CLI
In a new terminal session:
Download and install the AWS CLI: https://docs.aws.amazon.com/cli/latest/userguide/installing.html
Configure the AWS CLI:
```bash
$ aws configure
AWS Access Key ID [None]: insecure-dev-access-key
AWS Secret Access Key [None]: insecure-dev-secret-key
Default region name [None]: us-east-1
Default output format [None]:
$ aws configure set default.s3.multipart_threshold 1TB # until we support multipart
```
Test some commands:
### Upload an Object
```bash
$ aws s3 --endpoint=http://localhost:7777/ cp ~/Desktop/your-large-file.mp4 s3://bucket/your-large-file.mp4
```
### Download an Object
```bash
$ aws s3 --endpoint=http://localhost:7777/ cp s3://bucket/your-large-file.mp4 ~/Desktop/your-large-file.mp4
```
### List Objects
```bash
aws s3 --endpoint=http://localhost:7777/ ls s3://bucket/ --recursive
```
### Delete Objects in a Bucket
```bash
aws s3 --endpoint=http://localhost:7777/ rm --recursive s3://bucket/
```
### Generate a URL for an Object
```bash
aws s3 --endpoint=http://localhost:7777/ presign s3://bucket/your-large-file.mp4
```
For more information about the AWS s3 CLI visit: https://docs.aws.amazon.com/cli/latest/reference/s3/index.html
# Start Contibuting to Storj
### Install required packages
First of all, install `git` and `golang`.
First, install git and golang. We currently support Debian-based and Mac operating systems
#### Debian based (like Ubuntu)
Download and install the latest release of go https://golang.org/
```bash
apt-get install git golang
echo 'export STORJDEV="$HOME/storj"' >> $HOME/.bashrc
@ -63,15 +124,6 @@ rm -rf $STORJDEV/vendor/src/github.com/minio/minio/vendor/github.com/minio/cli
rm -rf $STORJDEV/vendor/src/github.com/minio/minio/vendor/golang.org/x/net/trace
```
### Run unit tests
```bash
go clean -testcache
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 the network
```bash
@ -80,25 +132,18 @@ $ captplanet setup
$ captplanet run
```
### Configure AWS CLI
### Try out some commands via Storj CLI or AWS CLI
Download and install the AWS CLI: https://docs.aws.amazon.com/cli/latest/userguide/installing.html
### Run unit tests
```bash
$ aws configure
AWS Access Key ID [None]: insecure-dev-access-key
AWS Secret Access Key [None]: insecure-dev-secret-key
Default region name [None]: us-east-1
Default output format [None]:
$ aws configure set default.s3.multipart_threshold 1TB # until we support multipart
go test storj.io/storj/...
```
### Do an upload
```bash
$ aws s3 --endpoint=http://localhost:7777/ cp large-file s3://bucket/large-file
```
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.
## Support
If you have any questions or suggestions please reach out to us on [Rocketchat](https://community.storj.io/) or [Twitter](https://twitter.com/storjproject).