add readme

1 files changed, 33 insertions, 0 deletions

diff --git a/readme.md b/readme.md
index e69de29..7733ab6 100644
--- a/readme.md
+++ b/readme.md
@@ -0,0 +1,33 @@
+# nm-pass
+
+This is a simple daemon that registers a "[NetworkManager Secret
+Agent][secret-agent]" D-Bus agent which reads network passwords from
+[pass][password-store]. This can be used to ensure sensitive network passwords
+are not saved in plain-text on disk.
+
+When nmpassswd is able to provide a password for a network, the connection will
+automatically be updated to not store its password under
+`/etc/NetworkManager/system-connections`.
+
+[secret-agent]: https://networkmanager.dev/docs/api/latest/gdbus-org.freedesktop.NetworkManager.SecretAgent.html
+[password-store]: https://www.passwordstore.org
+
+## setup
+
+```
+$ pip install .
+```
+
+And run
+
+```
+$ nmpassd
+```
+
+when starting your user session.
+
+## configuration
+
+The `NMPASS_FORMAT` environment variable can be set to configure the format
+used to lookup passwords. The default format is `net/{ssid}`.
+