aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorColin Okay <okay@toyful.space>2022-02-08 12:42:23 -0600
committerColin Okay <okay@toyful.space>2022-02-08 12:42:23 -0600
commit10bb776b1c30ef41a8f5ae36c80924a3485dd1ff (patch)
treedea7f73ee9e606ca46e1f2123f0103634b5b156e
parent6bca2e642b64ff8d4c66e425e4ea266641e86c5d (diff)
readme
-rw-r--r--README.md25
1 files changed, 17 insertions, 8 deletions
diff --git a/README.md b/README.md
index 1c3d386..2279400 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ Features include:
- Different server backends. (At the moment only Hunchnetoot is supported)
- Modular and "installable" applications.
- Handy macros for provisioning apps and defining endpoints.
-- Livecoding for your endpoint handlers and application confiturations.
+- Livecoding for your endpoint handlers and application configurations.
- Automatic documentation generation for `lazybones:app` instances.
Although lazybones can be used to develop and serve page-oriented web
@@ -15,14 +15,23 @@ sites, it has been written to help me develop "self documenting" HTTP
APIs.
-## Main components
+## Main Components
-The two main components are the classes `lazybones:app` and
-`lazybones:endpoint`. Endpoints are objects representing everything
-needed to handle an HTTP request. Endpoints are collected into groups
-called apps. Apps, in addition to being collections of endpoints, are
-the unit of development for larger lazybones projects. Apps can be
-"installed to" and "uninstalled from" a listening server on the fly.
+The main components in `lazybones` are the two classes: `lazybones:app`
+and `lazybones:endpoint`.
+
+Endpoints are objects that represent everything required to handle an
+HTTP request. Endpoints are collected into groups called apps.
+
+Apps, in addition to being collections of endpoints, are the main unit
+of development for larger lazybones projects. Apps can be installed to
+running servers on the fly as whole units. If desired, they can also
+be uninstalled. Apps are meant to be devolped in a
+one-app-per-package manner. That is, although you can create and work
+with multiple apps in a single Common Lisp package, `lazybones`
+encourages you to limit yourself to one per package.
+
+See the example below for more.
## Example