Skip to content

Commit

Permalink
Finished README
Browse files Browse the repository at this point in the history
  • Loading branch information
DaSourcerer committed Oct 14, 2013
1 parent b701c8a commit b848098
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,25 @@
yii-httpauth
httpauth
========
A filter implementing [HTTP basic auth](http://en.wikipedia.org/wiki/Basic_access_authentication), protecting single API
endpoints, specific actions and controllers or even entire applications.

Installation
============
Copy `HttpAuthFilter` into your `component` directory.

Usage
=====
Modify the controller you wish to protect in a way that the `filters()` method starts of like this:
```
public function filters()
{
return array(
array(
'HttpAuthFilter',
)
...
);
}
```
Make sure the filter is the first in the list and does not cover actions that should be reachable by unauthenticated
users (which were just cruel).

0 comments on commit b848098

Please sign in to comment.