Update README

This commit is contained in:
Michael Steinert
2015-03-28 19:44:51 -05:00
parent 2c5ae1bc4f
commit b380319c58
2 changed files with 15 additions and 14 deletions

14
README
View File

@@ -1,14 +0,0 @@
It's Go! It's PAM (Pluggable Authentication Modules)! It's GoPAM!
This is a Go wrapper for the PAM application API. There's not much
else to be said. PAM is a simple API and now it's available for use in Go
applications.
There's an example of a "fake login" program in the examples
directory. Look at the pam module's godocs for details about the Go
API; for a more general PAM application API reference, peep
http://www.kernel.org/pub/linux/libs/pam/Linux-PAM-html/adg-interface-by-app-expected.html
In the future, maybe the module API will be wrapped too. I don't know!

15
README.md Normal file
View File

@@ -0,0 +1,15 @@
[![Build Status](https://travis-ci.org/msteinert/pam.svg?branch=master)](https://travis-ci.org/msteinert/pam)
[![GoDoc](https://godoc.org/github.com/msteinert/pam?status.svg)](http://godoc.org/github.com/msteinert/pam)
# Go PAM
This is a Go wrapper for the PAM application API. There's not much
else to be said. PAM is a simple API and now it's available for use in Go
applications.
There's an example of a "fake login" program in the examples directory.
Look at the pam module's [godocs][1] for details about the Go API, or refer
to the official [PAM documentation][2].
[1]: http://godoc.org/github.com/msteinert/pam
[2]: http://www.kernel.org/pub/linux/libs/pam/Linux-PAM-html/adg-interface-by-app-expected.html