From 2df8f0708cba1a8b74da904ad14a3ef27f02e51d Mon Sep 17 00:00:00 2001 From: Tres Seaver <tseaver@palladion.com> Date: Fri, 03 Jun 2016 20:40:39 +0200 Subject: [PATCH] Garden / modernize README. --- README.rst | 45 ++++++++++++++++++++++++++++++++++++++++----- 1 files changed, 40 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index d8b9ea4..11cb758 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ -``repoze.who`` -============== +repoze.who +========== .. image:: https://travis-ci.org/repoze/repoze.who.png?branch=master :target: https://travis-ci.org/repoze/repoze.who @@ -14,9 +14,6 @@ .. image:: https://img.shields.io/pypi/pyversions/repoze.who.svg :target: https://pypi.python.org/pypi/repoze.who -Overview --------- - ``repoze.who`` is an identification and authentication framework for arbitrary WSGI applications. ``repoze.who`` can be configured either as WSGI middleware or as an API for use by an application. @@ -27,3 +24,41 @@ for authorization (ensuring whether a user can or cannot perform the operation implied by the request). This is considered to be the domain of the WSGI application. + +Installation +------------ + +Install using setuptools, e.g. (within a virtualenv):: + + $ easy_install repoze.who + +or using pip:: + + $ pip install repoze.who + + +Usage +----- + +For details on using the various components, please see the +documentation in ``docs/index.rst``. A rendered version of that documentation +is also available online: + + - http://repozewho.readthedocs.org/en/latest/ + + +Reporting Bugs +-------------- + +Please report bugs in this package to + + https://github.com/repoze/repoze.who/issues + + +Obtaining Source Code +--------------------- + +Download development or tagged versions of the software by visiting: + + https://github.com/repoze/repoze.who + -- Gitblit v1.9.3