gonk.git

diff --git a/README b/README
deleted file mode 100644
index b99d6d2e49bf016fb70b008d46664b45e630f10c..0000000000000000000000000000000000000000
--- a/README
+++ /dev/null
@@ -1,43 +0,0 @@
-= gonk
-
-terminal reader for honk (https://humungus.tedunangst.com/r/honk)
-
-== setup
-
-create file 'account' with three lines 
-
-```
-username = {username}
-password = {password}
-server = {server}
-```
-
-replace {variables} with what they should be. server should be just host name -- without 'http(s)://' in front
-
-== license
-
-gonk is adapted from honk examples
-
-```
-Copyright (c) 2019 Ted Unangst <tedu@tedunangst.com>
-```
-
-GPL applies (see LICENSE)
-
-```
-gonk -- honk reader
-Copyright (C) 2020 apiote
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <https://www.gnu.org/licenses/>.
-```




diff --git a/README.asciidoc b/README.asciidoc
new file mode 100644
index 0000000000000000000000000000000000000000..ab5c09312edcac55be03ca5aebedb227d093bbe7
--- /dev/null
+++ b/README.asciidoc
@@ -0,0 +1,47 @@
+= gonk
+
+terminal reader for honk (https://humungus.tedunangst.com/r/honk)
+
+== setup
+
+create file `account` in `XDG_CONFIG_HOME/gonk` (`$HOME/.config/gonk`) with three lines
+
+```
+username = {username}
+password = {password}
+server = {server}
+```
+
+replace {variables} with what they should be. server should be just host name -- without `http(s)://` in front
+
+== run
+
+run `gonk` to show honks with colours or `gonk -t` to show them without colours.
+
+== license
+
+gonk is adapted from honk examples
+
+```
+Copyright (c) 2019 Ted Unangst <tedu@tedunangst.com>
+```
+
+GPL applies (see LICENSE)
+
+```
+gonk -- honk reader
+Copyright (C) 2020 apiote
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+```