jscas-server/docs/Readme.md

An implementation of Apereo's CAS protocol

# Docs

This directory contains a set of documents describing all of the important
details of *JSCAS*. Such documentation covers the configuration of the server
to how to implement plugins.

Tip: use `npm run docs` from the project root directory to browse the
documentation in a web browser.

## TOC

- [API](/docs/API.md): details about the included API for plugin authors.
- [Configuration](/docs/Configuration.md): descriptions of the available
configuration parameters.
- [Hooks](/docs/Hooks.md): details on lifecycle hooks provided by *JSCAS*.
- [Plugins](/docs/Plugins.md): details the plugins API and how to implement specific
plugin types.
- [Tickets](/docs/Tickets.md): details what "tickets" are and how *JSCAS* expects
them to be shaped.