README updates

This commit is contained in:
Sarah Jamie Lewis 2019-06-25 15:49:11 -07:00
parent 03d784d7c4
commit 8c3f68f4f6
3 changed files with 31 additions and 1 deletions

View File

@ -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 <report.template>` 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.

View File

@ -0,0 +1 @@
https://openprivacy.ca/feed.xml 1440

BIN
report-pic.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 266 KiB