update readme

2020-06-15 05:17:43 -05:00 · 2020-06-15 05:17:43 -05:00 · f4316a54af
commit f4316a54af
parent c317111ccc
1 changed files with 23 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1,5 +1,27 @@
 dotfiles
 ========

-Here be dotfiles.
+Managed by [chezmoi][1], a dotfile manager.

+To install, grab a binary copy of chezmoi. Then run:
+
+```
+chezmoi init https://git.sr.ht/~iptq/dotfiles --apply
+```
+
+This will clone and perform initial installation of all required software packages. Re-login may be necessary.
+
+Features
+--------
+
+- zsh
+  + reminds you to update the system every week
+
+Contact
+-------
+
+License: GPL
+
+Author: Michael Zhang
+
+[1]: https://www.chezmoi.io/