From c42383d0093af6a0ca8b2cb102635984b18c447b Mon Sep 17 00:00:00 2001 From: Case Duckworth Date: Mon, 1 Jun 2020 15:08:53 -0500 Subject: update README --- README.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c987eed..df4e33e 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,9 @@ inspired by -=> https://github.com/dylanaraps/birch birch - -=> https://git.sr.ht/~julienxx/castor castor - -=> https://gemini.circumlunar.space/ gemini +* [birch](https://github.com/dylanaraps/birch) +* [castor](https://git.sr.ht/~julienxx/castor) +* [gemini](https://gemini.circumlunar.space/) # CAPABILITIES @@ -20,9 +18,10 @@ inspired by # STILL TO DO +* history -- + SEE the [history branch](https://git.sr.ht/~acdw/bollux/tree/history) * test configuring capabilities * bookmarks -* history * mailcap something * generate certificates? * implement TOFU? @@ -35,9 +34,6 @@ MIT # CONTRIBUTING Feel free to write to my - -=> https://lists.sr.ht/~acdw/public-inbox public inbox - +[public inbox](https://lists.sr.ht/~acdw/public-inbox) with changes you'd like to make, or submit an issue to the - -=> https://todo.sr.ht/~acdw/bollux ticket tracker. +[ticket tracker.](https://todo.sr.ht/~acdw/bollux) -- cgit 1.4.1-21-gabe81 From 23273c9fbaf7d8a31895d2dc53c537c15a9ffd11 Mon Sep 17 00:00:00 2001 From: Case Duckworth Date: Mon, 1 Jun 2020 15:13:31 -0500 Subject: Add INSTALL section --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index df4e33e..07ddde5 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,26 @@ inspired by * implement TOFU? * recognize more protocols +# INSTALL + +## From source + +``` +$ git clone https://git.sr.ht/~acdw/bollux +$ cd bollux +# make install +``` + +## Alternative + +``` +$ curl -fLo bollux https://git.sr.ht/~acdw/bollux/blob/0.2.2/bollux +$ chmod +x bollux +$ ./bollux +``` + +It's a bash script, so just plop it in your $PATH somewhere. + # LICENSE MIT -- cgit 1.4.1-21-gabe81