From cf80ba71f4c51a80934a39ccd8341192541eb429 Mon Sep 17 00:00:00 2001 From: Carsten H Date: Fri, 10 Apr 2015 13:20:50 +0200 Subject: [PATCH] Reword and clarify some sentences --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 295bb3706..2c14ee418 100644 --- a/README.md +++ b/README.md @@ -5,18 +5,17 @@ syncthing [![API Documentation](http://img.shields.io/badge/api-Godoc-blue.svg?style=flat-square)](http://godoc.org/github.com/syncthing/syncthing) [![MPLv2 License](http://img.shields.io/badge/license-MPLv2-blue.svg?style=flat-square)](https://www.mozilla.org/MPL/2.0/) -This is the `syncthing` project. The following are the project goals: +This is the `syncthing` project which pursues the following goals: 1. Define a protocol for synchronization of a folder between a number of - collaborating devices. The protocol should be well defined, unambiguous, + collaborating devices. This protocol should be well defined, unambiguous, easily understood, free to use, efficient, secure and language neutral. - This is the [Block Exchange + This is called the [Block Exchange Protocol](https://github.com/syncthing/specs/blob/master/BEPv1.md). 2. Provide the reference implementation to demonstrate the usability of - said protocol. This is the `syncthing` utility. It is the hope that - alternative, compatible implementations of the protocol will come to - exist. + said protocol. This is the `syncthing` utility. We hope that + alternative, compatible implementations of the protocol will arrise. 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 @@ -32,20 +31,20 @@ There are a few examples for keeping syncthing running in the background on your system in [the etc directory](https://github.com/syncthing/syncthing/blob/master/etc). There is an IRC channel, `#syncthing` on Freenode, for talking directly -to developers and users (when awake and present, etc.). +to developers and users. Building -------- Building Syncthing from source is easy, and there's a [guide](https://github.com/syncthing/syncthing/wiki/Building). -that describes it for both Unix and Windows. +that describes it for both Unix and Windows systems. Signed Releases --------------- As of v0.10.15 and onwards, git tags and release binaries are GPG signed -with the key D26E6ED000654A3E (see http://syncthing.net/security.html). +with the key D26E6ED000654A3E (see https://syncthing.net/security.html). For release binaries, MD5 and SHA1 checksums are calculated and signed, available in the md5sum.txt.asc and sha1sum.txt.asc files. @@ -57,4 +56,4 @@ documentation](https://github.com/syncthing/syncthing/wiki/) is on the Github wiki. All code is licensed under the -[MPLv2](https://github.com/syncthing/syncthing/blob/master/LICENSE). +[MPLv2 License](https://github.com/syncthing/syncthing/blob/master/LICENSE).