diff options
Diffstat (limited to 'doc/index.mdwn')
| -rw-r--r-- | doc/index.mdwn | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/index.mdwn b/doc/index.mdwn new file mode 100644 index 0000000..2b7f485 --- /dev/null +++ b/doc/index.mdwn @@ -0,0 +1,25 @@ +Lace - Lua Access Control Engine +================================ + +Lace is the core of an access control engine designed to be embedded into other +applications. It is also designed to be extended by the very applications it +is embedded into. + +As such, Lace provides only the core lexing, parsing, error handling and +related functionality of an access control engine, along with some initial +semantics to help the application developer along. + +All rules and mechanisms of deciding if access is to be permitted or not are up +to the application author to define. As such, while this documentation for +Lace will be useful for the application developer; it is recommended that the +applications do not refer their users to the Lace documentation except to +augment that provided in the application specific documentation. + +The Lace codebase provides an example of using the library which should be +referred to for getting started with Lace. However, there is also extensive +documentation on the [[syntax]] of Lace rulesets and also on the +[[compilation]] and [[execution]] phases of access control. + +If you wish to assist with Lace development, then see the [[developing]] +document for pointers around the codebase and the test suite. + |