diff README.md @ 184:42f747774d94

Really get documentation stuff squared away. Expand READMEs and polish off module documentation.
author Paul Fisher <paul@pfish.zone>
date Thu, 31 Jul 2025 14:36:50 -0400
parents 9e4ce1631bd3
children
line wrap: on
line diff
--- a/README.md	Wed Jul 30 18:43:07 2025 -0400
+++ b/README.md	Thu Jul 31 14:36:50 2025 -0400
@@ -1,7 +1,7 @@
 # 🍳 nonstick
 
-Nonstick lets you use PAM (Pluggable Authentication Modules) from Rust safely.
-Don't worry about getting stuck on unsafe code.
+Nonstick lets you use PAM (Pluggable Authentication Modules) from Rust.
+Never worry about getting stuck on unsafe code.
 
 You can use nonstick for interacting with PAM from both sides:
 
@@ -16,6 +16,15 @@
 
 Further documentation can be found in the crate's rustdoc.
 
+## Why use nonstick?
+
+- Safe, idiomatic Rust API.
+- Supports both modules and client applications.
+- Works with all PAM implementations.
+- Does not require system headers.
+- Few dependencies, fast builds (no `syn`!).
+- Well-tested on multiple platforms (AMD64 Linux, FreeBSD, and Illumos).
+
 ## Status
 
 - **Modules**: full support for all calls by PAM into modules.