aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README9
1 files changed, 9 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..b091a5d
--- /dev/null
+++ b/README
@@ -0,0 +1,9 @@
+Archives-Ag: Gentoo Archives, backend tool.
+
+Setup instructions:
+- Set up Elasticsearch
+- bundle install
+- bundle exec ag --help
+- bundle exec ag --index-full $MAILDIR
+- bundle exec ag --index-new $MAILDIR
+