diff options
Diffstat (limited to 'angelsharkd/src/routes/extensions/README.md')
| -rw-r--r-- | angelsharkd/src/routes/extensions/README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/angelsharkd/src/routes/extensions/README.md b/angelsharkd/src/routes/extensions/README.md new file mode 100644 index 0000000..1aed1dd --- /dev/null +++ b/angelsharkd/src/routes/extensions/README.md @@ -0,0 +1,13 @@ +# Angelshark Daemon Extensions + +This module aims to provide a simple way of extending Angelshark's basic +functionality (running commands on the ACM) with additional HTTP endpoints that +run one or more commands to achieve a basic business task. + +This functionality may not be desirable for all end users, and therefore is +completely opt-in with feature flags. For example, at compile time, you can add +`--features simple_search` to enable a given extension called `simple_search`. + +To add additional features, read `mod.rs` and `Cargo.toml` for `angelsharkd` to +see how to conditionally incorporate your own warp HTTP filters into the +project. |