@hitchy/plugin-auth 0.2.0 → 0.3.0

package/readme.md

@@ -1,57 +1,25 @@
-# hitchy-plugin-auth
+# @hitchy/plugin-auth
 
-[![Build Status](https://travis-ci.org/hitchyjs/plugin-auth.svg?branch=master)](https://travis-ci.org/hitchyjs/plugin-auth)
+[![pipeline status](https://gitlab.com/hitchy/plugin-auth/badges/master/pipeline.svg)](https://gitlab.com/hitchy/plugin-auth/-/commits/master)
+
+_request authentication and authorization for Hitchy framework_
 
 ## License
 
-MIT
+[MIT](LICENSE)
 
 ## Usage
 
-When in root folder of a Hitchy-based application run this command:
+Run this command in a hitchy-based project's root folder containing its **package.json** file:
 
 ```
-npm i @hitchy/plugin-auth @hitchy/plugin-session @hitchy/plugin-cookies @hitchy/plugin-odem
+npm i @hitchy/plugin-auth
 ```
 
-It will install this plugin as well as its peer dependencies you are in charge of.
-
-After restarting your application the plugin is discovered and injecting some policy routes used to detect current context of either request and to expose some additional information and API regarding user authentication and authorization.
-
-### REST-API
-
-The plugin injects special endpoints for managing a user's authentication.
-
-| endpoint | method | description |
-|----------|--------|-------------|
-| `/api/auth/login` | POST | Takes username and password in request body and uses them for authenticating selected user. |
-| `/api/auth/login` | GET | Does the same as the POST method and is mainly here as a redirect URI for external authorization |
-| `/api/auth/logout` | GET | Drops information on previously authenticated user. |
-| `/api/auth/check` | GET | Fetches status information on currently authenticated user. |
-
-In addition, this plugin is injecting policy requiring authenticated user to have authorization for role `admin` for accessing REST endpoint `/api/user`.
-
-### Server-Side Session
-
-The plugin is controlling information on authenticated user in current server-side session. 
-
-When combined with [@hitchy/plugin-session](https://www.npmjs.com/package/@hitchy/plugin-session) this results in exposing information on currently authenticated user and its authorization in headers of every response.
-
-### Creating First Account
-
-The endpoint `/api/auth/login` is always checking whether there is at least one user with role `admin` in the configured database. If there is no such user the controller is implicitly creating one with username `admin`, password `nimda` and role `admin`.
-
-## Upcoming Revisions
-
-### High Priority
-
-* Add an endpoint in scope of `/api/auth` for creating new user account.
-
-### Medium Priority
-
-* Improve authorization system by adding additional level of customizable access control.
+It will install this plugin as a dependency.
 
+After restarting your application the plugin is discovered by Hitchy automatically. It is injecting some routes instantly suitable for authentication based on a local database.
 
-## Note
+## Manual
 
-This plugin comes with a very limited set of supported features, currently. It is though intended to include additional features over time.
+Read the [plugin's official manual](https://auth.hitchy.org/) e.g. for [routes supported by default](https://auth.hitchy.org/api/routing.html) and how to use [all the components this plugin is introducing](https://auth.hitchy.org/api/).