diff --git a/README.md b/README.md index f8d0afdae..56824c4bc 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Syncthing -[![Latest Linux & Cross Build](https://img.shields.io/jenkins/s/http/build.syncthing.net/syncthing.svg?style=flat-square&label=linux+%26+cross)](http://build.syncthing.net/job/syncthing/lastBuild/) -[![Latest Windows Build](https://img.shields.io/jenkins/s/http/build.syncthing.net/syncthing-windows.svg?style=flat-square&label=windows)](http://build.syncthing.net/job/syncthing/lastBuild/) -[![Latest Mac Build](https://img.shields.io/jenkins/s/http/build.syncthing.net/syncthing-mac.svg?style=flat-square&label=mac)](http://build.syncthing.net/job/syncthing/lastBuild/) -[![Latest Solaris Build](https://img.shields.io/jenkins/s/http/build.syncthing.net/syncthing-solaris.svg?style=flat-square&label=solaris)](http://build.syncthing.net/job/syncthing/lastBuild/) -[![API Documentation](https://img.shields.io/badge/api-Godoc-blue.svg?style=flat-square)](http://godoc.org/github.com/syncthing/syncthing) +[![Latest Linux & Cross Build](https://img.shields.io/jenkins/s/http/build.syncthing.net/syncthing.svg?style=flat-square&label=linux+%26+cross)](https://build.syncthing.net/job/syncthing/lastBuild/) +[![Latest Windows Build](https://img.shields.io/jenkins/s/http/build.syncthing.net/syncthing-windows.svg?style=flat-square&label=windows)](https://build.syncthing.net/job/syncthing/lastBuild/) +[![Latest Mac Build](https://img.shields.io/jenkins/s/http/build.syncthing.net/syncthing-mac.svg?style=flat-square&label=mac)](https://build.syncthing.net/job/syncthing/lastBuild/) +[![Latest Solaris Build](https://img.shields.io/jenkins/s/http/build.syncthing.net/syncthing-solaris.svg?style=flat-square&label=solaris)](https://build.syncthing.net/job/syncthing/lastBuild/) +[![API Documentation](https://img.shields.io/badge/api-Godoc-blue.svg?style=flat-square)](https://godoc.org/github.com/syncthing/syncthing) [![MPLv2 License](https://img.shields.io/badge/license-MPLv2-blue.svg?style=flat-square)](https://www.mozilla.org/MPL/2.0/) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/88/badge)](https://bestpractices.coreinfrastructure.org/projects/88) [![Go Report Card](https://goreportcard.com/badge/github.com/syncthing/syncthing)](https://goreportcard.com/report/github.com/syncthing/syncthing) @@ -98,7 +98,7 @@ All code is licensed under the [MPLv2 License][7]. [1]: https://docs.syncthing.net/specs/bep-v1.html [2]: https://docs.syncthing.net/intro/getting-started.html [3]: https://github.com/syncthing/syncthing/blob/master/etc -[4]: http://www.freenode.net/irc_servers.shtml +[4]: http://www.freenode.net/ [5]: https://docs.syncthing.net/dev/building.html [6]: https://docs.syncthing.net/ [7]: https://github.com/syncthing/syncthing/blob/master/LICENSE diff --git a/cmd/stcli/README.md b/cmd/stcli/README.md deleted file mode 100644 index 7caa2206a..000000000 --- a/cmd/stcli/README.md +++ /dev/null @@ -1,10 +0,0 @@ -syncthing-cli -============= - -[![Latest Build](http://img.shields.io/jenkins/s/http/build.syncthing.net/syncthing-cli.svg?style=flat-square)](http://build.syncthing.net/job/syncthing-cli/lastBuild/) - -A CLI that talks to the Syncthing REST interface. - -`go get github.com/syncthing/syncthing-cli` - -Or download the [latest build](http://build.syncthing.net/job/syncthing-cli/lastSuccessfulBuild/artifact/). diff --git a/cmd/stdiscosrv/README.md b/cmd/stdiscosrv/README.md index 695386e91..7de906c7b 100644 --- a/cmd/stdiscosrv/README.md +++ b/cmd/stdiscosrv/README.md @@ -1,14 +1,8 @@ stdiscosrv ========== -[![Latest Build](http://img.shields.io/jenkins/s/http/build.syncthing.net/stdiscosrv.svg?style=flat-square)](http://build.syncthing.net/job/stdiscosrv/lastBuild/) - This is the global discovery server for the `syncthing` project. -To get it, run `go get github.com/syncthing/stdiscosrv` or download the -[latest build](http://build.syncthing.net/job/stdiscosrv/lastSuccessfulBuild/artifact/) -from the build server. - Usage ----- diff --git a/cmd/strelaypoolsrv/README.md b/cmd/strelaypoolsrv/README.md index c9e5dd911..7b5f332eb 100644 --- a/cmd/strelaypoolsrv/README.md +++ b/cmd/strelaypoolsrv/README.md @@ -1,16 +1,19 @@ # relaypoolsrv -[![Latest Build](http://img.shields.io/jenkins/s/http/build.syncthing.net/relaypoolsrv.svg?style=flat-square)](http://build.syncthing.net/job/relaypoolsrv/lastBuild/) +This is the relay pool server for the `syncthing` project, which allows +community hosted [relaysrv](https://github.com/syncthing/relaysrv)'s to join +the public pool. -This is the relay pool server for the `syncthing` project, which allows community hosted [relaysrv](https://github.com/syncthing/relaysrv)'s to join the public pool. +Servers that join the pool are then advertised to users of `syncthing` as +potential connection points for those who are unable to connect directly due +to NAT or firewall issues. -Servers that join the pool are then advertised to users of `syncthing` as potential connection points for those who are unable to connect directly due to NAT or firewall issues. - -There is very little reason why you'd want to run this yourself, as `relaypoolsrv` is just used for announcement and lookup of public relay servers. If you are looking to setup a private or a public relay, please check the documentation for [relaysrv](https://github.com/syncthing/relaysrv), which also explains how to join the default public pool. - -If you still want to run it, you can run `go get github.com/syncthing/relaypoolsrv` download it or download the -[latest build](http://build.syncthing.net/job/relaypoolsrv/lastSuccessfulBuild/artifact/) -from the build server. +There is very little reason why you'd want to run this yourself, as +`relaypoolsrv` is just used for announcement and lookup of public relay +servers. If you are looking to setup a private or a public relay, please +check the documentation for +[relaysrv](https://github.com/syncthing/relaysrv), which also explains how +to join the default public pool. See `relaypoolsrv -help` for configuration options. diff --git a/cmd/strelaysrv/README.md b/cmd/strelaysrv/README.md index 59367b868..43255bf08 100644 --- a/cmd/strelaysrv/README.md +++ b/cmd/strelaysrv/README.md @@ -1,14 +1,8 @@ strelaysrv ========== -[![Latest Build](http://img.shields.io/jenkins/s/http/build.syncthing.net/strelaysrv.svg?style=flat-square)](http://build.syncthing.net/job/strelaysrv/lastBuild/) - This is the relay server for the `syncthing` project. -To get it, run `go get github.com/syncthing/syncthing/cmd/strelaysrv` or download the -[latest build](http://build.syncthing.net/job/strelaysrv/lastSuccessfulBuild/artifact/) -from the build server. - :exclamation:Warnings:exclamation: - Read or regret -----