2018-08-20 20:46:45 +01:00
# Storj V3 Network
2018-04-06 17:32:34 +01:00
2019-04-16 00:23:56 +01:00
[![Go Report Card ](https://goreportcard.com/badge/storj.io/storj )](https://goreportcard.com/report/storj.io/storj)
2020-04-13 21:31:48 +01:00
[![Go Doc ](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square )](https://pkg.go.dev/storj.io/storj)
2020-12-28 21:59:06 +00:00
[![Coverage Status ](https://img.shields.io/badge/coverage-master-green.svg )](https://build.dev.storj.io/job/storj/job/main/cobertura)
2018-11-16 02:03:41 +00:00
![Alpha ](https://img.shields.io/badge/version-alpha-green.svg )
2018-04-06 17:32:34 +01:00
2020-12-28 21:59:06 +00:00
< img src = "https://github.com/storj/storj/raw/main/resources/logo.png" width = "100" >
2018-04-06 17:32:34 +01:00
2019-10-21 09:48:32 +01:00
Storj is building a decentralized cloud storage network.
2021-05-03 10:27:07 +01:00
[Check out our white paper for more info! ](https://storj.io/storj.pdf )
2018-04-06 17:32:34 +01:00
----
2018-10-30 01:50:38 +00:00
Storj is an S3-compatible platform and suite of decentralized applications that
2018-08-29 16:28:29 +01:00
allows you to store data in a secure and decentralized manner. Your files are
encrypted, broken into little pieces and stored in a global decentralized
2018-08-26 17:38:38 +01:00
network of computers. Luckily, we also support allowing you (and only you) to
2018-08-29 16:28:29 +01:00
retrieve those files!
2018-04-06 17:32:34 +01:00
2018-08-17 20:05:03 +01:00
## Table of Contents
2018-10-30 00:36:17 +00:00
- [Contributing ](#contributing-to-storj )
2018-10-30 01:50:38 +00:00
- [Start using Storj ](#start-using-storj )
2018-08-29 16:28:29 +01:00
- [License ](#license )
2018-08-17 20:05:03 +01:00
- [Support ](#support )
2018-10-30 00:36:17 +00:00
# Contributing to Storj
2021-09-24 18:11:32 +01:00
All of our code for Storj v3 is open source. If anything feels off, or if you feel that
some functionality is missing, please check out the [contributing page ](https://github.com/storj/storj/blob/main/CONTRIBUTING.md ).
There you will find instructions for sharing your feedback, building the tool locally,
and submitting pull requests to the project.
2018-10-30 01:50:38 +00:00
2020-03-26 00:53:11 +00:00
### A Note about Versioning
2021-04-09 23:25:25 +01:00
While we are practicing [semantic versioning ](https://semver.org/ ) for our client
libraries such as [uplink ](https://github.com/storj/uplink ), we are *not* practicing
semantic versioning in this repo, as we do not intend for it to be used via
[Go modules ](https://blog.golang.org/using-go-modules ). We may have
2020-03-26 00:53:11 +00:00
backwards-incompatible changes between minor and patch releases in this repo.
2018-10-30 01:50:38 +00:00
# Start using Storj
2018-08-29 16:28:29 +01:00
2018-12-30 02:02:55 +00:00
Our wiki has [documentation and tutorials ](https://github.com/storj/storj/wiki ).
2018-10-30 01:50:38 +00:00
Check out these three tutorials:
2018-08-29 16:28:29 +01:00
2018-12-30 02:02:55 +00:00
* [Using the Storj Test Network ](https://github.com/storj/storj/wiki/Test-network )
* [Using the Uplink CLI ](https://github.com/storj/storj/wiki/Uplink-CLI )
* [Using the S3 Gateway ](https://github.com/storj/storj/wiki/S3-Gateway )
2018-08-29 16:28:29 +01:00
# License
2018-10-25 08:02:52 +01:00
The network under construction (this repo) is currently licensed with the
[AGPLv3 ](https://www.gnu.org/licenses/agpl-3.0.en.html ) license. Once the network
reaches beta phase, we will be licensing all client-side code via the
2018-08-29 16:28:29 +01:00
[Apache v2 ](https://www.apache.org/licenses/LICENSE-2.0 ) license.
2018-10-30 01:50:38 +00:00
For code released under the AGPLv3, we request that contributors sign our
[Contributor License Agreement (CLA) ](https://docs.google.com/forms/d/e/1FAIpQLSdVzD5W8rx-J_jLaPuG31nbOzS8yhNIIu4yHvzonji6NeZ4ig/viewform ) so that we can relicense the
2018-08-29 16:28:29 +01:00
code under Apache v2, or other licenses in the future.
# Support
2018-04-06 17:32:34 +01:00
2018-08-26 17:38:38 +01:00
If you have any questions or suggestions please reach out to us on
2021-04-09 23:25:25 +01:00
[our community forum ](https://forum.storj.io/ ) or file a ticket at
https://support.storj.io/.