aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2020-01-07 10:36:35 +1300
committerTom Ryder <tom@sanctum.geek.nz>2020-01-07 10:36:35 +1300
commitce7bd22af9d55eada0cff15f719f338dd212f2e0 (patch)
tree0c63840969a53b41140a9cc4349a00b7b1dddb8c /README.md
parentMore idiomatic Makefile (diff)
parentAdd VERSION (diff)
downloadcrypt-1.0.0.tar.gz (sig)
crypt-1.0.0.zip
Merge branch 'release/v1.0.0'v1.0.0
* release/v1.0.0: Add VERSION More refactoring and rearranging, commenting Switch to tab indentation Refactor usage function and output Rename to README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cb45439
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+`crypt(1)`
+==========
+
+A convenience wrapper for UNIX `crypt(3)`. Includes a manual page and `-h`
+output and nothing else.
+
+ $ make
+ $ sudo make install
+
+Or put it somewhere else:
+
+ $ make install PREFIX="$HOME"/.local
+
+License
+-------
+
+Copyright (c) [Tom Ryder][1]. Distributed under an [MIT License][2].
+
+[1]: https://sanctum.geek.nz/
+[2]: https://www.opensource.org/licenses/MIT