diff options
author | Carpenter, Adam (CORP) <adam.carpenter@adp.com> | 2021-11-30 16:04:37 -0500 |
---|---|---|
committer | Carpenter, Adam (CORP) <adam.carpenter@adp.com> | 2021-11-30 16:04:37 -0500 |
commit | e18d0c1a4189d5278639a9b323ae3794118566bc (patch) | |
tree | a582caae4e8c0706041497fb16a2525a14002c2e /angelsharkd/src/routes/extensions/README.md | |
parent | cd9f750990166dfa9b9fc0276749be307e26d008 (diff) | |
download | altruistic-angelshark-e18d0c1a4189d5278639a9b323ae3794118566bc.tar.xz altruistic-angelshark-e18d0c1a4189d5278639a9b323ae3794118566bc.zip |
docs: updated readmes
Diffstat (limited to 'angelsharkd/src/routes/extensions/README.md')
-rw-r--r-- | angelsharkd/src/routes/extensions/README.md | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/angelsharkd/src/routes/extensions/README.md b/angelsharkd/src/routes/extensions/README.md index b9192fe..1aed1dd 100644 --- a/angelsharkd/src/routes/extensions/README.md +++ b/angelsharkd/src/routes/extensions/README.md @@ -1,12 +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 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. -For example, say you would like you, other users, or your own software to quickly search all extension-types for a keyword. This functionality is not in the base `angelsharkd`, but it can be easily implemented with the following steps: +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`. -1. Accept a keyword from the client's request -1. Download extension-type data from one or more ACMs -1. Filter out extensions that do not match a given keyword -1. Return the remaining, matching extensions to the client - -This functionality may not be desirable for all end users, and therefor is completely opt-in with feature flags. At compile time, you can add `--features simple_search` to enable a given extension called `simple_search`, for example. +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. |