aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8443079
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+This is a simple password generator that I created because I was tired of thinking up of passwords. All randomness is produced by the [libsodium](https://github.com/jedisct1/libsodium) library.
+## Dependencies
+- `make`
+- `libsodium`
+
+## Install
+- `make`
+- `sudo make install`
+
+## Uninstall
+- `sudo make uninstall`
+
+