summaryrefslogtreecommitdiff
path: root/lib/lace.lua
diff options
context:
space:
mode:
authorDaniel Silverstone <dsilvers@digital-scurf.org>2013-12-09 21:29:40 +0100
committerDaniel Silverstone <dsilvers@digital-scurf.org>2013-12-09 21:29:40 +0100
commitb79a19ca1f3f87a14f55257fad3c1ec47e6a36ea (patch)
tree1b74d9425903a5341d7831a78091b4979b7b8bd3 /lib/lace.lua
parent8086445183e2cdb52e6c3d926f8ebdd8667c397e (diff)
downloadlace-b79a19ca1f3f87a14f55257fad3c1ec47e6a36ea.tar.gz
More documentation
Diffstat (limited to 'lib/lace.lua')
-rw-r--r--lib/lace.lua8
1 files changed, 7 insertions, 1 deletions
diff --git a/lib/lace.lua b/lib/lace.lua
index 9e039d6..2c76cb8 100644
--- a/lib/lace.lua
+++ b/lib/lace.lua
@@ -9,7 +9,13 @@
--- Lua Access Control Engine.
--
---
+-- The Lua Access Control Engine library consists primarily of a ruleset
+-- compiler and execution engine. In addition there is a lexer and also a
+-- complex error reporting system designed to ensure application authors who
+-- use Lace in their projects can provide good error messages to their users.
+--
+-- * For compiling rulesets, see `lace.compiler.compile`.
+-- * For running compiled rulesets, see `lace.engine.run`.
local lex = require "lace.lex"
local compiler = require "lace.compiler"