aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9a7445a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Proxy
+
+Proxy denying connections according to the given configuration.
+
+## Getting started
+
+```bash
+nix-shell --run "cargo-watch -x run -- --config config.dhall"
+```
+
+## Example configuration
+
+```dhall
+[
+ {
+ from = "00:00",
+ to = "23:59",
+ hosts = [
+ "facebook.com",
+ "gstatic.com"
+ ]
+ },
+ {
+ from = "19:00",
+ to = "17:00",
+ hosts = [
+ "youtube.com"
+ ]
+ }
+]
+```