From 228e1a26ac4617e12c7f39a241fa226a50803db2 Mon Sep 17 00:00:00 2001
From: Atreya Bain <atreyabain@gmail.com>
Date: Fri, 25 Oct 2024 12:37:30 +0100
Subject: [PATCH] [add] readme

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/README.md b/README.md
index e69de29..9a0b4f9 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,29 @@
+
+# hosts2blocker
+
+Converts a hosts file into a list of domains.
+
+```
+Usage: hosts2blocker [OPTIONS]
+
+Options:
+  -i, --input-file <INPUT_FILE>    [default: input.txt]
+  -o, --output-file <OUTPUT_FILE>  [default: output.txt]
+  -h, --help                       Print help
+  -V, --version                    Print version
+```
+
+#### Example
+
+Input: 
+```hosts
+0.0.0.0 google.com
+0.0.0.0 github.com
+```
+
+Output:
+```
+google.com
+github.com
+```
+