aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAdam Mathes <adam@trenchant.org>2017-02-21 20:36:50 -0800
committerAdam Mathes <adam@trenchant.org>2017-02-21 20:36:50 -0800
commit29d2102bd4b7a838a82cbc58559f41065955f00a (patch)
tree84968663016986f7451744af61c4860e359734ab /README.md
parenta26cf26c2d70e2d3a14b25956889d1c009ea834d (diff)
downloadneko-29d2102bd4b7a838a82cbc58559f41065955f00a.tar.gz
neko-29d2102bd4b7a838a82cbc58559f41065955f00a.tar.bz2
neko-29d2102bd4b7a838a82cbc58559f41065955f00a.zip
readme updates
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md
index 21594ca..6b29878 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,9 @@
# Neko
-Simple self-hosted, single user RSS reader focused on efficiency and simplicity. Written in Go with a simple javascript ui frontend.
+
+`neko` is a self-hosted, rss news reader focused on simplicity and efficiency.
+
+Backend is written in `Go` and there is a simple javascript frontend and cat ears.
*the cat ears are in your mind*
@@ -25,9 +28,8 @@ This is not very easy to use/setup/ yet. Sorry! Consider it WIP, pull requests f
### Prerequesites
-[Go](https://golang.org)
-
-[MySQL](https://dev.mysql.com) or a drop-in replacement like [MariaDB](https://mariadb.com)
+ * [Go](https://golang.org)
+ * [MySQL](https://dev.mysql.com) or a drop-in replacement like [MariaDB](https://mariadb.com)
PostgreSQL support is left as an exercise for the reader to implement and send a pull request for.