summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index b0b1e95..3c82f03 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,23 @@
*A simple blog generator written in bash*
+### Facts
+
+- Doesn't depend on GNU extensions
+
+- POSIX compliant
+
+- Works on non-GNU distros (such as Alpine)
+
+- Works on BSD systems (such as MacOS and OpenBSD)
+
+- Only depends on `markdown`/`hoedown`
+
+- Less than 100 SLOC
+
### How to use
-First, install `markdown` because this script uses it heavily.
+First, install `markdown` or `hoedown` because this script uses it heavily.
Put your markdown files on `articles/<name of file>.md` (create the directory if it doesn't exist).
@@ -30,4 +44,6 @@ Seen supports other options too, for more info, run the following:
$ ./seen.sh --help
+You can create RSS feeds too, just modify the `rss.cfg` file to your liking and:
+ $ ./seen.sh --rss