intial version

README.md

@@ -0,0 +1,17 @@
+# Pamsock
+
+Exposes PAM authentication via a unix socket.
+
+It's meanth to be secure enough to be mindlessly executed as root in its daemon form, because PAM requies root to interact with it. Code is simple enough for that reason, an audit should be really fast and dependency use is minimal for convenient stuff.
+
+# Building
+
+Requires `PAM_SERVICE` env variable at compile time (I recommend `login` for average distributions) to specify the name of the PAM service to login as.
+
+# Docs
+
+The protocol is dead simple and is documented with `cargo doc` under `lib::prot`. Also provides some utils to interact as a client with with library part of this project.
+
+# License
+
+Code licensed under the WTFPL.