github.com/kayoticsully/syncthing@v0.8.9-0.20140724133906-c45a2fdc03f8/README.md (about)

     1  syncthing [![Build Status](https://travis-ci.org/calmh/syncthing.svg?branch=master)](https://travis-ci.org/calmh/syncthing) [![Coverage Status](https://img.shields.io/coveralls/calmh/syncthing.svg)](https://coveralls.io/r/calmh/syncthing?branch=master)
     2  =========
     3  
     4  This is the `syncthing` project. The following are the project goals:
     5  
     6   1. Define a protocol for synchronization of a file repository between a
     7      number of collaborating nodes. The protocol should be well defined,
     8      unambiguous, easily understood, free to use, efficient, secure and
     9      language neutral. This is the [Block Exchange
    10      Protocol](https://github.com/calmh/syncthing/blob/master/protocol/PROTOCOL.md).
    11  
    12   2. Provide the reference implementation to demonstrate the usability of
    13      said protocol. This is the `syncthing` utility. It is the hope that
    14      alternative, compatible implementations of the protocol will come to
    15      exist.
    16  
    17  The two are evolving together; the protocol is not to be considered
    18  stable until syncthing 1.0 is released, at which point it is locked down
    19  for incompatible changes.
    20  
    21  Getting Started
    22  ---------------
    23  
    24  Take a look at the [getting started guide](http://discourse.syncthing.net/t/getting-started/46).
    25  
    26  Signed Releases
    27  ---------------
    28  
    29  As of v0.7.0 and onwards, git tags and release binaries are GPG signed with
    30  the key BCE524C7 (http://nym.se/gpg.txt). The signature is included in the
    31  normal release bundle as `syncthing.asc` or `syncthing.exe.asc`.
    32  
    33  Documentation
    34  =============
    35  
    36  The [syncthing
    37  documentation](http://discourse.syncthing.net/category/documentation) is
    38  on the discourse site.
    39  
    40  License
    41  =======
    42  
    43  All documentation and protocol specifications are licensed
    44  under the [Creative Commons Attribution 4.0 International
    45  License](http://creativecommons.org/licenses/by/4.0/).
    46  
    47  All code is licensed under the [MIT
    48  License](https://github.com/calmh/syncthing/blob/master/LICENSE).