From 583680f66cefdb4691d953c43ba30658bca3f3a6 Mon Sep 17 00:00:00 2001
From: Dominic Reich <freefallcid@users.noreply.github.com>
Date: Fri, 4 Mar 2016 11:46:22 +0100
Subject: [PATCH] Create README.md

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..827a736
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# Fewo-Blacklist
+
+A simple command line tool to manage a blacklist.
+The following two files need to exist in the (actual) working directory.
+
+* `daten.txt` - can be empty
+* `counter.txt` - write a single zero (`0`) into the first line
+
+## For example
+
+### Put the files into your home directory
+
+You can run the tool in your home directory.
+It does not care where the binary file is, as long as you are in your home directory.
+
+### Put the files into a separate directory under your home directory
+
+If you put the two files into `.fewo` in your home directory, you have to go into that directory first and run the command then.
+It does not care where the binary file is, as long as you are in that specific directory.
+
+### Change the source code to use absolute paths
+
+Open main.cpp and re-define the filename of those two files (that information is on line 60 and 61).
+
+```C++
+  const char * cFilename = "daten.txt";
+  const char * cCounter  = "counter.txt";
+```
+
+You can easily change this to something else and compile again.
+
+```C++
+  const char * cFilename = "/var/lib/blacklist/daten.txt";
+  const char * cCounter  = "/var/lib/blacklist/counter.txt";
+```
+
+## Others
+
+Feedback and suggenstions welcome!