diff options
| author | Chris Ball <chris@printf.net> | 2015-05-26 21:58:41 -0400 |
|---|---|---|
| committer | Chris Ball <chris@printf.net> | 2015-05-26 21:58:41 -0400 |
| commit | 02d7e716a9abf07d532842222374de581319768f (patch) | |
| tree | a6897025aff3efa946483866fb789c170e92e6ed | |
| parent | 7fd60e8a7183b9848b016717c89c5b9e6e691289 (diff) | |
Update README
| -rw-r--r-- | README.md | 26 |
1 files changed, 23 insertions, 3 deletions
@@ -1,7 +1,8 @@ -GitSwarm -======== +#  -GitSwarm is a project to explore what a decentralized GitHub would look like -- a global file store that's powered by cooperation and sharing rather than a big datacenter with disks and bandwidth. +### The Decentralization of GitHub + +**GitSwarm** is a peer-to-peer network of Git repositories being shared over BitTorrent. To get started: ``` @@ -82,3 +83,22 @@ e.g. ``` Note that OP_RETURN transactions are limited to 80 bytes, which limits usernames in this scheme to 29 bytes. + +## Contributing + +Please send pull requests! Even changes to the design of GitSwarm are welcome and encouraged; nothing is set in stone. + +#### JavaScript Standard Style + +GitSwarm uses [JavaScript Standard Style](https://github.com/feross/standard). + +[](https://github.com/feross/standard) + +#### Enable debug logs + +In **node**, enable debug logs by setting the `DEBUG` environment variable to the name of the +module you want to debug (e.g. `bittorrent-protocol`, or `*` to print **all logs**). + +### License + +MIT. Copyright (c) [Chris Ball](http://printf.net). |
