Add initial (#1)

README.md

@@ -1 +1,29 @@
-# rfd-notify
+# rfd-notify
+
+![](https://github.com/davegallant/rfd-notify/workflows/.github/workflows/ci.yml/badge.svg)
+
+This tool looks for regular expressions from [RedFlagDeals.com forums](https://forums.redflagdeals.com/hot-deals-f9/) and will send emails based on matches.
+
+
+## requirements
+
+- a free [SendGrid API key](https://sendgrid.com/pricing/)
+
+## use
+
+Declare a configuration. An example can found in [config.toml](./examples/config.toml)
+
+```shell
+rfd-notify ./examples/config.toml
+```
+
+## cross compile
+
+I had motivations to run this on a Raspberry Pi Zero:
+
+```shell
+alias rust-musl-builder='docker run --rm -it -v "$(pwd)":/home/rust/src messense/rust-musl-cross:arm-musleabihf'
+rust-musl-builder cargo build --release
+```
+
+The above can be substituted for [other architectures](https://github.com/messense/rust-musl-cross#prebuilt-images).