From 16accbc643278f6bd1a09a784072cb6bd02ecbc4 Mon Sep 17 00:00:00 2001 From: Fritjof Bornebusch Date: Sun, 16 Aug 2015 21:25:46 +0200 Subject: [PATCH 1/2] Reorder README.md for a better overview. --- README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3f82951..c1a430d 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,13 @@ provides is similar NameCoin's, but `dename` does not rely on proof of work -- instead, each client can pick a set of verifier servers which it believes to contain at least one honest member. +## Dependencies + +The [`go` toolchain] is required for compiling. +Every additional dependency will be downloaded and compiled during +`dename`'s compile process. Please note that some global variables such +as `GOROOT` and `GOPATH` must be set - [see here](http://golang.org/doc/install). + ## Usage Let's say a friend of yours wishes to grant you write access to a `git` @@ -34,8 +41,6 @@ inconvenient. go get github.com/andres-erbsen/dename/{dnmgr/dnmgr,dnmlookup} -This requires the [`go` language toolchain](http://golang.org/). - To update an existing `dename` installation, run go get -u github.com/andres-erbsen/dename/{dnmgr/dnmgr,dnmlookup} @@ -99,6 +104,7 @@ long lost won't be cluttering the namespace forever. To make sure legitimate users do not lose control of their profiles, lookups will start returning an error earlier -- currently at the 6 months mark. The profile does not need to change, any `dnmgr set` command will bump the expiration time if successful. +The ``dnmgr update ` updates the profile without changing it. ### Scripts @@ -172,11 +178,14 @@ somebody else the trouble. Technical and non-technical feedback are equally appreciated. To get in touch with us, use the Github issues link on this page or [contact us](mailto:dename@mit.edu) by email. -the public mailing list +The public mailing list [dename-servers@mit.edu](http://mailman.mit.edu/mailman/listinfo/dename-servers) will receive notifications about updates and issues related to the dename utilities and the server software respectively. +People interested in `dename` are encouraged to join our irc +channel: #dename @ irc.freenode.net + ### Integrate `dename` with `$YOUR_FAVORITE_APPLICATION` `dename` is designed to be easy to integrate into other applications for a @@ -234,13 +243,14 @@ rough idea on how to set up an independent server. [update "dename.mit.edu:6263"] TransportPublicKey = 4f2i+j65JCE2xNKhxE3RPurAYALx9GRy0Pm9c6J7eDY= -5. (or if you get stuck) Email [dename@mit.edu](mailto:dename.mit.edu) and let - us know how it went, and whether you'd like to have your server added to a - public list of [community servers](community-servers.md). +#### Community server - People interested about `dename` are encouraged to join our irc channel: #dename @ irc.freenode.net +If you want to run a server send us an email [dename@mit.edu](mailto:dename.mit.edu) with +the domain, the `PublicKey` and the `TransportPublicKey` of your server. +There is a list of all [community servers](community-servers.md) available. [OpenPGP]: https://andreser.scripts.mit.edu/blog/2013-08-10-how-to-use-openpgp-for-email-in-1000-words/ [`ssh` host key]: http://www.rackspace.com/knowledge_center/article/rackspace-cloud-essentials-checking-a-server%E2%80%99s-ssh-host-fingerprint-with-the-web-console#Explaining [`signify`]: http://www.openbsd.org/cgi-bin/man.cgi/OpenBSD-current/man1/signify.1 [software transparency]: https://zyan.scripts.mit.edu/blog/software-transparency/ +[`go` toolchain]: http://golang.org/ From 3210e796d167d8b9d6573100892e9c4ae056f7d4 Mon Sep 17 00:00:00 2001 From: Fritjof Bornebusch Date: Sun, 16 Aug 2015 22:03:56 +0200 Subject: [PATCH 2/2] Typo. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c1a430d..2ecc9f5 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ long lost won't be cluttering the namespace forever. To make sure legitimate users do not lose control of their profiles, lookups will start returning an error earlier -- currently at the 6 months mark. The profile does not need to change, any `dnmgr set` command will bump the expiration time if successful. -The ``dnmgr update ` updates the profile without changing it. +The `dnmgr update ` command updates the profile without changing it. ### Scripts