From b380319c58ed6bf1023f8e58f78f593fa28c234b Mon Sep 17 00:00:00 2001 From: Michael Steinert Date: Sat, 28 Mar 2015 19:44:51 -0500 Subject: [PATCH] Update README --- README | 14 -------------- README.md | 15 +++++++++++++++ 2 files changed, 15 insertions(+), 14 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 52cf817..0000000 --- a/README +++ /dev/null @@ -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! - diff --git a/README.md b/README.md new file mode 100644 index 0000000..d41a5fd --- /dev/null +++ b/README.md @@ -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