diff --git a/README.md b/README.md index 06b2e94..c204460 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ -# raccoon +# Raccoon - A tool for privately generating reports from data feeds + +I wanted a tool that would provide the following features: + +* Fetch data from the Internet at defined periods over Tor +* Allow me to display that data in a configurable way. +* Would let me extend the functionality over time. + +After investigating a few options I could find nothing that fit quite right. + +![](report-pic.png) + +## Usage + +Create a new folder to hold all of your feeds e.g. + + mkdir feeds + cd feeds + +Create some feeds, each feed is a subfolder that contains a file `feedinfo` e.g. + + mkdir openprivacy-blog + echo "https://openprivacy.ca/feed.xml 1440" > openprivacy-blog/feedinfo + +For now `feedinfo` just contains a single line with the URL of the feed and how often to check for updates (in minutes, in this case 1440 is once per day) + +You can now run `raccoon update` to fetch all of your feeds over Tor. It will only attempt to fetch feeds that haven't been checked for the given update period. + +To produce reports, you can run `raccoon report ` and raccoon will produce a markdown/html hybrid of a report that can be piped to a utility like `markdown` to produce a html report. + diff --git a/openprivacy-blog/feedinfo b/openprivacy-blog/feedinfo new file mode 100644 index 0000000..1bf3a42 --- /dev/null +++ b/openprivacy-blog/feedinfo @@ -0,0 +1 @@ +https://openprivacy.ca/feed.xml 1440 diff --git a/report-pic.png b/report-pic.png new file mode 100644 index 0000000..acbdf52 Binary files /dev/null and b/report-pic.png differ