Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Complex module documentation #64

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from
Open

Complex module documentation #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)