diff options
| author | Colin Okay <okay@toyful.space> | 2022-02-13 19:46:08 -0600 |
|---|---|---|
| committer | Colin Okay <okay@toyful.space> | 2022-02-13 19:46:08 -0600 |
| commit | 128f72863fa3f736c93175267beb23292e70e096 (patch) | |
| tree | 64f432bc8e99cd917bcefddee16d2dbf5b7133cf | |
| parent | 49f8cafff4b63ebb7c0fa3bfc182072d8d5197ea (diff) | |
updated readme
| -rw-r--r-- | README.md | 9 |
1 files changed, 6 insertions, 3 deletions
@@ -7,6 +7,9 @@ Features include: - Different server backends. (At the moment only Hunchentoot is supported) - Modular and "installable" applications. - Handy macros for provisioning apps and defining endpoints. +- In particular, endpoint routes may contain variables and include + parsers for variables and for query parameters +- customizable errors. - Livecoding supported for your endpoint handlers and application configurations. - Automatic documentation generation for `lazybones:app` instances. @@ -14,7 +17,6 @@ Although lazybones can be used to develop and serve page-oriented web sites, it has been written to help me develop "self documenting" HTTP APIs. - ## Main Components The main components in `lazybones` are the two classes: `lazybones:app` @@ -46,7 +48,8 @@ See the example below for more. (in-package :hello-lazybones) (defendpoint* :get "/hello/:name:" () () - (http-ok (format nil "Welcome to Lazybones, ~a" name))) + "Responds with a greeting to NAME" + (format nil "Welcome to Lazybones, ~a" name)) (defvar *my-server* (lzb:create-server)) (lzb:install-app *my-server* (lzb:app)) @@ -77,7 +80,7 @@ Welcome to Lazybones, colin ``` -Check the `example` directory in this repository for another example. +Check the `example` directory in this repository for a more elaborate example. ## Documentation Generation |