aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAdam Mathes <adam@trenchant.org>2018-07-04 16:54:55 -0700
committerAdam Mathes <adam@trenchant.org>2018-07-04 16:54:55 -0700
commitc97f927f3f1d6cc8333d41c92531dc5a32232144 (patch)
tree5f9ec2095125a53f3bfb92c02db25f5854728c23 /README.md
parent893ea3825efea1f2ec187780e8653a1a2641d173 (diff)
downloadneko-c97f927f3f1d6cc8333d41c92531dc5a32232144.tar.gz
neko-c97f927f3f1d6cc8333d41c92531dc5a32232144.tar.bz2
neko-c97f927f3f1d6cc8333d41c92531dc5a32232144.zip
documentation updates
Diffstat (limited to 'README.md')
-rw-r--r--README.md138
1 files changed, 104 insertions, 34 deletions
diff --git a/README.md b/README.md
index 49d0be8..f20d94c 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,43 @@
+<pre style="font-family: menlo, courier, monospace;">
+ ▄▄
+ ██
+ ██▄████▄ ▄████▄ ██ ▄██▀ ▄████▄
+ ██▀ ██ ██▄▄▄▄██ ██▄██ ██▀ ▀██
+ ██ ██ ██▀▀▀▀▀▀ ██▀██▄ ██ ██
+ ██ ██ ▀██▄▄▄▄█ ██ ▀█▄ ▀██▄▄██▀
+ ▀▀ ▀▀ ▀▀▀▀▀ ▀▀ ▀▀▀ ▀▀▀▀
+
+
+
+ v0.2 manual
+ 7/4/2018
+</pre>
+<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-generate-toc again -->
+**Table of Contents**
+
+- [Neko](#neko)
+ - [Features](#features)
+ - [Screenshots](#screenshots)
+- [Installation](#installation)
+ - [Requirements](#requirements)
+ - [Building](#building)
+- [Configuration](#configuration)
+ - [Storage](#storage)
+- [Usage](#usage)
+ - [Web Interface](#web-interface)
+ - [Add Feed](#add-feed)
+ - [Crawl Feeds](#crawl-feeds)
+ - [Export](#export)
+- [All Command Line Options](#all-command-line-options)
+- [TODO](#todo)
+- [History](#history)
+ - [Early 2017](#early-2017)
+ - [July 2018 -- v0.2](#july-2018----v02)
+- [Feedback](#feedback)
+
+<!-- markdown-toc end -->
+
+
# Neko
`neko` is a self-hosted, rss reader focused on simplicity and efficiency.
@@ -14,21 +54,23 @@ Backend is written in `Go` and there is a simple javascript frontend and cat ear
* **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)
+ * full text search
+ * scrapes full text of pages on demand
## Screenshots
-![Alt text](/screenshot/neko.jpg?raw=true "Screenshot 1")
+![Screenshot 1](screenshot/neko.jpg?raw=true "Screenshot 1")
-![Alt text](/screenshot/neko2.jpg?raw=true "Screenshot 2")
+![Screenshot 2](screenshot/neko2.jpg?raw=true "Screenshot 2")
-## Installation
+# Installation
-### Requirements
+## Requirements
* [Go](https://golang.org)
* [SQLite](https://sqlite.org/)
-### Building
+## Building
$ go get adammathes.com/neko
@@ -36,11 +78,11 @@ This will download `neko`, dependencies, and build them all in `$GOPATH/src/`. B
A `neko` binary should now be in `$GOPATH/bin/`. By default this is usually `$HOME/go/bin/`
-## Configuration
+# Configuration
There's no configuration file -- everything is handled with a few command line flags. You shouldn't need to change the defaults most of the time.
-### Storage
+## Storage
By default `neko` will create the file `neko.db` in the current directory for storage.
@@ -48,11 +90,15 @@ You can override the location of this database file with the `--database` comman
$ neko --database=/var/db/neko.db --add=http://trenchant.org/rss.xml
-For expert users -- this is a [SQLite](https://sqlite.org/) database and can be manipulated with standard sqlite commands.
+For expert users -- this is a [SQLite](https://sqlite.org/) database and can be manipulated with standard sqlite commands --
+
+ $ sqlite3 neko.db .schema
+
+-- will print out the database schema.
-## Usage
+# Usage
-### Run Web Interface
+## Web Interface
You can do most of what you need to do with `neko` from the web interface, which is what `neko` does by default.
@@ -67,20 +113,22 @@ You can specify a different port using the `--http` option.
If you are hosting on a publicly available server instead of a personal computer, you can protect the interface with a password flag --
$ neko --password=rssisveryimportant
-
-### Add Feeds
+
+## Add Feed
You can add feeds directly from the command line for convenience --
$ neko --add=http://trenchant.org/rss.xml
-### Crawl Feeds
+## Crawl Feeds
+
+By default `neko` will crawl your feeds every 60 minutes while the interface is running, but if you want to manually crawl from the command line --
$ neko --update
This will fetch, download, parse, and store in the database your feeds.
-### Export
+## Export
Export de facto RSS feed standard OPML from the command line with --
@@ -92,17 +140,35 @@ Export is also available in the web interface.
Import of OPML and other things is a TODO item.
-## Operationalize
-
-### Crawl Regularly Via Cron
-
-Depending on your database file and other bits --
-
- 34 * * * * neko -d /home/neko/neko.db -u
-
--- should crawl regularly on the hour in cron.
-
-## TODO
+# All Command Line Options
+
+View all command line options with `-h` or `--help`
+
+ $ neko -h
+
+Usage of neko:
+ -a, --add http://example.com/rss.xml
+ add the feed at URL http://example.com/rss.xml
+ -d, --database string
+ sqlite database file (default "neko.db")
+ -x, --export string
+ export feed. format required: text, json or opml
+ -h, --help
+ print usage information
+ -s, --http int
+ HTTP port to serve on (default 4994)
+ -i, --imageproxy
+ rewrite and proxy all image requests for privacy (experimental)
+ -m, --minutes int
+ minutes between crawling feeds (default 60)
+ -p, --password string
+ password to access web interface
+ -u, --update
+ fetch feeds and store new items
+ -v, --verbose
+ verbose output
+
+# TODO
* manually initiate crawl/refresh from web interface
* auto-refresh feeds from web interface
@@ -112,21 +178,25 @@ Depending on your database file and other bits --
* prettify interface
* cross-compilation of binaries for "normal" platforms
-## History
+# History
-### Early 2017
+## Early 2017
I decided I didn't like the [original version of this 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 keep saying I will rewrite that too since it's old backbone.js code but it still seems to mostly work. It's not very pretty though.
-### July 2018
+## July 2018 -- v0.2
Significant changes to simplify setup, configuration, usage. The goal was typing `neko` should be all you need to do to get started and use the software.
- * removed MySQL requirement (eliminating a ton of configuration and complexity)
- * added SQLite support (easier!)
- * auto-initialization of database file with embedded schema
- * removed json-formatted config file -- all options are command line options
- * `neko` runs web server by default
- * `neko` server crawls feeds regularly rather than requiring cron
+ * removed MySQL requirement (eliminating a ton of configuration and complexity)
+ * added SQLite support (easier!)
+ * auto-initialization of database file with embedded schema
+ * removed json-formatted config file -- all options are command line options
+ * `neko` runs web server by default
+ * `neko` server crawls feeds regularly rather than requiring cron
+
+# Feedback
+
+Pull requests and issues are welcomed at https://github.com/adammathes/neko