From 0311e4c3d986998ed9df4d6cb48af0ab0ba4ebc0 Mon Sep 17 00:00:00 2001 From: Lucio Delelis Date: Thu, 3 Oct 2019 23:42:18 -0300 Subject: [PATCH] doc(): details the process of implementing complex modules --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index c6b7cd1..1e8177d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,11 @@ # scepter Spiritual successor to Nixbot + +## Contributing + +### Complex modules + +For certain modules, you might find you need too much logic to make a single file easy to read. + +Thanks to how Javascript's import system works, we allow for a module to be imported as a directory. +As an only condition, this directory requires an `index.ts` file at its root, with all the appropiate attributes (check `Module` type definition for details defined there) \ No newline at end of file