plugeth/swarm
Anton Evangelatov 763e64cad8 swarm: readme.md
2018-07-19 12:13:03 +02:00
..
api swarm: integrate OpenTracing; propagate ctx to internal APIs (#17169) 2018-07-13 17:40:28 +02:00
bmt swarm: ctx propagation; bmt fixes; pss generic notification framework (#17150) 2018-07-09 14:11:49 +02:00
dev swarm: bzz-list, bzz-raw and bzz-immutable schemes (#15667) 2017-12-19 10:49:30 +02:00
fuse swarm: integrate OpenTracing; propagate ctx to internal APIs (#17169) 2018-07-13 17:40:28 +02:00
grafana_dashboards swarm: network rewrite merge 2018-06-21 21:10:31 +02:00
log swarm: network rewrite merge 2018-06-21 21:10:31 +02:00
metrics swarm: ctx propagation; bmt fixes; pss generic notification framework (#17150) 2018-07-09 14:11:49 +02:00
multihash swarm: network rewrite merge 2018-06-21 21:10:31 +02:00
network swarm/network: bump up protocol versions due to wrapped message intro (#17170) 2018-07-13 17:40:55 +02:00
pot swarm: network rewrite merge 2018-06-21 21:10:31 +02:00
pss swarm: integrate OpenTracing; propagate ctx to internal APIs (#17169) 2018-07-13 17:40:28 +02:00
services/swap swarm: network rewrite merge 2018-06-21 21:10:31 +02:00
spancontext swarm: integrate OpenTracing; propagate ctx to internal APIs (#17169) 2018-07-13 17:40:28 +02:00
state swarm: network rewrite merge 2018-06-21 21:10:31 +02:00
storage swarm: integrate OpenTracing; propagate ctx to internal APIs (#17169) 2018-07-13 17:40:28 +02:00
testutil swarm: network rewrite merge 2018-06-21 21:10:31 +02:00
tracing swarm: integrate OpenTracing; propagate ctx to internal APIs (#17169) 2018-07-13 17:40:28 +02:00
AUTHORS swarm: network rewrite merge 2018-06-21 21:10:31 +02:00
network_test.go swarm: ctx propagation; bmt fixes; pss generic notification framework (#17150) 2018-07-09 14:11:49 +02:00
OWNERS swarm: network rewrite merge 2018-06-21 21:10:31 +02:00
README.md swarm: readme.md 2018-07-19 12:13:03 +02:00
state.go swarm: network rewrite merge 2018-06-21 21:10:31 +02:00
swarm_test.go swarm: ctx propagation; bmt fixes; pss generic notification framework (#17150) 2018-07-09 14:11:49 +02:00
swarm.go swarm: integrate OpenTracing; propagate ctx to internal APIs (#17169) 2018-07-13 17:40:28 +02:00

Swarm

https://swarm.ethereum.org

Swarm is a distributed storage platform and content distribution service, a native base layer service of the ethereum web3 stack. The primary objective of Swarm is to provide a decentralized and redundant store for dapp code and data as well as block chain and state data. Swarm is also set out to provide various base layer services for web3, including node-to-node messaging, media streaming, decentralised database services and scalable state-channel infrastructure for decentralised service economies.

Travis Gitter

Building the source

Building Swarm requires Go (version 1.10 or later).

go get -d github.com/ethereum/go-ethereum

go install github.com/ethereum/go-ethereum/cmd/swarm

Documentation

Swarm documentation can be found at https://swarm-guide.readthedocs.io.

Contribution

Thank you for considering to help out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!

If you'd like to contribute to Swarm, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base. If you wish to submit more complex changes though, please check up with the core devs first on our Swarm gitter channel to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.

Please make sure your contributions adhere to our coding guidelines:

  • Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
  • Code must be documented adhering to the official Go commentary guidelines.
  • Pull requests need to be based on and opened against the master branch.
  • Commit messages should be prefixed with the package(s) they modify.
    • E.g. "swarm/fuse: ignore default manifest entry"

License

The go-ethereum library (i.e. all code outside of the cmd directory) is licensed under the GNU Lesser General Public License v3.0, also included in our repository in the COPYING.LESSER file.

The go-ethereum binaries (i.e. all code inside of the cmd directory) is licensed under the GNU General Public License v3.0, also included in our repository in the COPYING file.