Commit 16f0705c authored by Ray Bellis's avatar Ray Bellis

updated README text

parent 12263fd1
......@@ -84,21 +84,38 @@ See `test-auth-node.js` and `test-acct-node.js` for examples.
RADIUS Dictionaries
-------------------
The framework can read the dictionary files supplied with FreeRADIUS
3.x, but does not (yet) support the RADIUS Extensions described in [RFC
6929](https://tools.ietf.org/html/rfc6929). Dictionary entries using
those extensions are ignored.
Only the base RFC 2865 and 2866 dictionary files are included. If you
need further dictionary files (e.g. for Vendor-Specific support) please
obtain those from the FreeRADIUS package (version 3.x).
Other Limitations
-----------------
Note that the framework does not (yet) support the RADIUS Extensions
described in [RFC 6929](https://tools.ietf.org/html/rfc6929).
Dictionary entries using those extensions are ignored.
Only PAP authentication is supported.
Limitations
-----------
Only PAP authentication is supported in the current release. There
is no EAP support.
Documentation
-------------
All API functions have documentation in jsdoc format. To build it,
run `npm install` and then `npm run docs`.
All API functions have documentation in jsdoc format in the docs/ folder.
To rebuild them (e.g. if building from git) run `npm install` from the
project folder and then `npm run docs`.
Design Goals
------------
Most objects within the framework are designed to be unmodifiable to
help prevent third party modules from changing the behaviour of the
system.
For example, a received `RadiusPacket` that is passed as the `request`
parameter to a callback function cannot be modified, although the
`response` packet can be modified by changing its response code or by
adding (but not removing) attributes.
Support
-------
......
{
"name": "isc-radius",
"version": "0.1.2",
"version": "0.2.0",
"description": "ISC RADIUS Framework",
"directories": {
"doc": "docs",
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment