summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJakob Borg <jakob@nym.se>2014-02-20 17:40:15 +0100
committerJakob Borg <jakob@nym.se>2014-02-20 17:42:17 +0100
commit5837277f8d070847f6bca215abfd8072a072c677 (patch)
tree507b7ef1c1f48826685ec9cb7bef177d28f199b3 /README.md
parent87d473dc8f61f8b633c037b40eb9190045a7c88c (diff)
Rework XDR encoding
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 14 insertions, 10 deletions
diff --git a/README.md b/README.md
index 5ebebc3a59..bca960daeb 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,18 @@
syncthing
=========
-This is `syncthing`, an open BitTorrent Sync alternative. It is
-currently far from ready for mass consumption, but it is a usable proof
-of concept and tech demo. The following are the project goals:
+This is the `syncthing` project. The following are the project goals:
- 1. Define an open, secure, language neutral protocol usable for
- efficient synchronization of a file repository between an arbitrary
- number of nodes. This is the [Block Exchange
- Protocol](https://github.com/calmh/syncthing/blob/master/protocol/PROTOCOL.md)
- (BEP).
+ 1. Define a protocol for synchronization of a file repository between a
+ number of collaborating nodes. The protocol should be well defined,
+ unambigous, easily understood, free to use, efficient, secure and
+ languange neutral. This is the [Block Exchange
+ Protocol](https://github.com/calmh/syncthing/blob/master/protocol/PROTOCOL.md).
2. Provide the reference implementation to demonstrate the usability of
- said protocol. This is the `syncthing` utility.
+ said protocol. This is the `syncthing` utility. It is the hope that
+ alternative, compatible implementations of the protocol will come to
+ exist.
The two are evolving together; the protocol is not to be considered
stable until syncthing 1.0 is released, at which point it is locked down
@@ -34,5 +34,9 @@ The syncthing documentation is kept on the
License
=======
-MIT
+All documentation and protocol specifications are licensed
+under the [Creative Commons Attribution 4.0 International
+License](http://creativecommons.org/licenses/by/4.0/).
+All code is licensed under the [MIT
+License](https://github.com/calmh/syncthing/blob/master/LICENSE).