Merge pull request #83 from evilguy50/main

added nim filter docs
Bedrock-OSS · Oct 21, 2021 · f6ec853 · f6ec853
2 parents 4eb6f8c + 03b070a
commit f6ec853
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/docs/_pages/docs/filters/nim-filters.md b/docs/_pages/docs/filters/nim-filters.md
@@ -0,0 +1,22 @@
+---
+permalink: /docs/nim-filters
+layout: single
+classes: wide
+title: Nim Filters
+sidebar:
+  nav: "sidebar"
+---
+
+The syntax for running a nim filter is this:
+
+```json
+{
+  "runWith": "nim",
+  "script": "./filters/example.nim"
+}
+```
+
+## Requirements and Dependencies
+
+If your filter has dependencies, put a .nimble file in the same directory as your .nim file.
+Documentation on how to make a .nimble file is located at https://github.com/nim-lang/nimble#creating-packages