aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAdam Mathes <adam@trenchant.org>2018-06-17 15:21:54 -0700
committerAdam Mathes <adam@trenchant.org>2018-06-17 15:21:54 -0700
commit29b012f8a995136ab832aac44311af919152ae24 (patch)
treefafa85cf77820fa2c49c48dace03c5e91cce0b5a /README.md
parent7d9fe867d9405a5686594a32eb001b9992baee49 (diff)
downloadneko-29b012f8a995136ab832aac44311af919152ae24.tar.gz
neko-29b012f8a995136ab832aac44311af919152ae24.tar.bz2
neko-29b012f8a995136ab832aac44311af919152ae24.zip
add screenshots, update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/README.md b/README.md
index 0d084df..7488059 100644
--- a/README.md
+++ b/README.md
@@ -8,9 +8,9 @@ Backend is written in `Go` and there is a simple javascript frontend and cat ear
## Huh?
-I decided I didn't like the [old version that was python and mongo](https://github.com/adammathes/neko_v1) so rewrote it. I wanted to learn some Go. So assume the code is bad since I don't know what I'm doing even more so than normal.
+I decided I didn't like the [old version that was python and mongo](https://github.com/adammathes/neko_v1) so rewrote it. I wanted to learn some Go. So assume the code is not great since I don't know what I'm doing even more so than normal.
-The javascript frontend is still the same, I might rewrite that too since it's old backbone.js code and in the intervening years it looks like nobody uses that anymore.
+The Javascript frontend is still the same, I might rewrite that too since it's old backbone.js code and in the intervening years it looks like nobody uses that anymore.
This is not very easy to use/setup/ yet. Sorry! Consider it WIP, pull requests for containers/snaps/etc welcome.
@@ -22,7 +22,13 @@ This is not very easy to use/setup/ yet. Sorry! Consider it WIP, pull requests f
* **k** - previous item
* that's all you should ever need
* automatically marks items read in an infinite stream of never-ending content (until you run out of content and it ends)
-
+
+## Screenshots
+
+![Alt text](/screenshot/neko.jpg?raw=true "Screenshot 1")
+
+![Alt text](/screenshot/neko2.jpg?raw=true "Screenshot 2")
+
## Installation
### Prerequesites
@@ -32,8 +38,6 @@ This is not very easy to use/setup/ yet. Sorry! Consider it WIP, pull requests f
* [SQLite](https://sqlite.org/) (newly supported and easiest to setup)
* [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.
-
### Set up $GOPATH if one doesn't exist already
$ mkdir $HOME/go
@@ -59,6 +63,8 @@ Initialize a new SQLite database file with `sqlite.init.sql`
#### Create MySQL table and user
+This is harder. Use SQLite! MySQL support may be deprecated soonish.
+
If you are using MySQL or equivalent --
$ mysqladmin -uroot -p create neko