From 6929ddfb164027e3691324fe0222e0a16775c8c8 Mon Sep 17 00:00:00 2001 From: Kai Kubasta Date: Tue, 9 Feb 2016 23:28:42 +0100 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index f031a50..6ba4c01 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ - htwtxt – hosted twtxt server +htwtxt – hosted twtxt server ============================ Rationale --------- -"twtxt" is a protocol and client () for +[*twtxt*](https://github.com/buckket/twtxt) is a protocol and client for decentralized microblogging. Users are expected to provide their feeds as plain -text files with URLs accessible over the Internet. "htwtxt" is a web server to +text files with URLs accessible over the Internet. *htwtxt* is a web server to host and grow such text files for users without trivial access to their own web space. @@ -14,8 +14,8 @@ Clone, build, run ----------------- With htwtxt written in Go, the following instructions expect a Go development -environment with the go tool () installed, and the -$GOPATH set: +environment with [the go tool](https://golang.org/cmd/go/) installed, and the +`$GOPATH` set: git clone https://github.com/plomlompom/htwtxt $GOPATH/src/htwtxt go get htwtxt @@ -25,7 +25,7 @@ $GOPATH set: $GOPATH/bin/htwtxt This will build and start the server, and set up directories and files expected -by it below ~/htwtxt (or any other path you prefer instead of this). +by it below `~/htwtxt` (or any other path you prefer instead of this). Configuring port number and TLS ------------------------------- @@ -35,8 +35,8 @@ accepts up to three optional arguments to change this: $GOPATH/bin/htwtxt [PORT] [CERTIFICATE] [KEY] -PORT is the port number to serve. CERTIFICATE and KEY are paths to the -certificate and key files needed to run htwtxt as a HTTPS server. +`PORT` is the port number to serve. `CERTIFICATE` and `KEY` are paths to the +certificate and key files needed to run *htwtxt* as a HTTPS server. Copyright, license ------------------