feat: Adding StatefulSuricataRuleGroup.fromFile to readme. (#70)

* Adding StatefulSuricataRuleGroup.fromFile to readme. Adding aws-cdk-lib to dev dependencies * Fixing typo --------- Co-authored-by: Zane Durkin <8985088+durkinza@users.noreply.github.com>
durkinza · Nov 6, 2023 · 849831a · 849831a
1 parent 9c1e86c
commit 849831a
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 1 deletion.
diff --git a/.cspell.json b/.cspell.json
diff --git a/.projen/deps.json b/.projen/deps.json
diff --git a/.projenrc.ts b/.projenrc.ts
@@ -17,6 +17,7 @@ const project = new awscdk.AwsCdkConstructLibrary({
  '@types/node',
  '@typescript-eslint/eslint-plugin',
  '@typescript-eslint/parser',
+ 'aws-cdk-lib',
  'constructs',
  'eslint',
  'eslint-import-resolver-node',

diff --git a/API.md b/API.md
diff --git a/README.md b/README.md
@@ -217,6 +217,14 @@ new NetFW.StatefulSuricataRuleGroup(stack, 'MyStatefulSuricataRuleGroup', {
 });
 ```
 
+Suricata rule groups can also be imported from a file. 
+```ts
+const ruleGroup:NetFW.StatefulSuricataRuleGroup = NetFW.StatefulSuricataRuleGroup.fromFile(stack, 'MyStatefulSuricataRuleGroup', {
+ path: './suricata.rules'
+});
+```
+All other arguments for creating a Suricata Rule Group are also supported here with an exception of the `rules` property. 
+The `rules` property will be filled in with the contents from the file path, anything supplied will be ignored.
 
 ### Firewall Logs
 

diff --git a/package.json b/package.json