From 18bbcf5fd706ab68c7c86012bd1c70804461ec5b Mon Sep 17 00:00:00 2001
From: Aadi Desai <21363892+supleed2@users.noreply.github.com>
Date: Sun, 7 May 2023 22:46:12 +0100
Subject: [PATCH] Create README.md

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..20ba374
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# namehash-rs
+
+## CLI program for hashing domain names according to EIP-137
+
+Compute the namehash of individual domains or multiple domains at once from a file.
+
+## Usage
+
+```shell
+> .\namehash
+Usage: namehash <COMMAND>
+
+Commands:
+  domain  Get the namehash of a single domain
+  file    Get the namehashes of many domains at once
+  help    Print this message or the help of the given subcommand(s)
+
+Options:
+  -h, --help  Print help
+>
+> .\namehash domain 8bit.x
+8bit.x: 0xb7c50b1d5594286e2fff20a5aa108021ffb1cc70c1afb67934e3729aa3e44c39
+>
+> .\namehash file -h
+Get the namehashes of many domains at once
+
+Usage: namehash file [OPTIONS] <INPUT>
+
+Arguments:
+  <INPUT>  Path to input file, domains to hash with 1 per line
+
+Options:
+  -o, --output <FILE>  File to save hashes to, stdout if not given
+  -h, --help           Print help
+```