comparison README.md @ 2:e69e2966ae0d

Replaces generated README
author Jesse Hallett <jesse@galois.com>
date Thu, 05 Mar 2015 16:33:43 -0800
parents 8ed8b2cfd909
children a5cc18a3db47
comparison
equal deleted inserted replaced
1:b195a14058bb 2:e69e2966ae0d
1 # rust-pam 1 rust-pam
2 A PAM binding in the Rust programming language. 2 ========
3
4 Rust interface to the pluggable authentication module framework (PAM).
5
6 The goal of this library is to provide a type-safe API that can be used to
7 interact with PAM. The library is incomplete - currently it supports a subset
8 of functions for use in a pam authentication module. A pam module is a shared
9 library that is invoked to authenticate a user, or to perform other functions.
10
11 For more information, see the package documentation. To build the
12 documentation:
13
14 $ cargo doc
15
16 Then open
17
18 target/doc/pam/index.html