aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/readme.md b/readme.md
index 05b61cc..ef98b75 100644
--- a/readme.md
+++ b/readme.md
@@ -1,4 +1,16 @@
# meta adservices
-A funny adservice. To promote each others free software projects or websites like one would in
-a webring.
+A funny adservice. To promote each others free software projects or websites
+like one would in a webring.
+
+## Usage
+
+1. Build with cargo: `cargo build --release`
+2. Write a configuration file. See [sample_config.yaml](./sample_config.yaml)
+3. Run it: `meta-adservices your_config.yaml`
+
+Ask questions in issues or [contact me](https://metamuffin.org/contact).
+
+## License
+
+AGPL-3.0-only; See [COPYING](./COPYING)