diff --git a/readme.md b/readme.md index 3b72cde..e497986 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,11 @@ +# Reddit Ingest + +Distributed server/client setup for ingesting all of reddit. + +- Scales to multiple clients. +- Supports reddit authentication. +- Tolerant to clients losing state/going offline. + ```bash # ...install PostgreSQL... pip install -r requirements.txt @@ -7,8 +15,10 @@ mv fetcher_config.example.yaml fetcher_config.yaml mkdir logs bash compile_proto.sh -# Then run both of these files: +# Run one instance of batcher.py: python batcher.py + +# And several instances of fetcher.py: python fetcher.py ```