1 files changed, 37 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..0e31dc6
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,37 @@
+
+# Wig
+
+A simple and lightweight dns client written in C
+
+## How to
+
+`usage: wig [@server] [options] domain [qtype]`
+
+For simple usage, just type the domain name followed by the record type: `example.com AAAA`. Or you can just type the domain, `example.com`, and it will default to the A record.
+
+If you want to use a custom dns server, just specify the ip or domain after the @ like `@1.1.1.1` or `@ns1.google.com`.
+
+If you want to specify a port, you can add `-p port_num`.
+
+Finally, if you want to force tcp, you can add `-t`.
+
+## License
+
+This project is Licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html)
+
+## Compilation
+
+Wig only runs on Linux systems that are Posix 1995 compliant
+
+Make sure to have `gcc` and `make` installed, and then run
+
+```shell
+$ make # compiles the program
+$ sudo make install # installs the binary
+```
+
+If you wish to remove the program, you can run
+
+```shell
+$ sudo make uninstall # removes the binary
+```