From 353ad4c44f8fd8f9a04270e230eeab56346182d6 Mon Sep 17 00:00:00 2001 From: Lucio Delelis Date: Thu, 3 Oct 2019 23:29:41 -0300 Subject: [PATCH] doc(): details env requirements and dev environment setup --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index c6b7cd1..56b5efd 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # scepter Spiritual successor to Nixbot + +## Requirements +* Node >= 10.15 +* [A Discord bot account](https://www.digitaltrends.com/gaming/how-to-make-a-discord-bot/) + +## Contributing + +* Clone the repo +* Install dependencies `npm i` +* Set up the required environment variables: + + * SCEPTER_BOT_GUILD: The bot's instance's main server, in which logging will occur + * SCEPTER_DISCORD_TOKEN: The bot's token, as given to you by Discord's development site + * SCEPTER_OWNER_IDS: A colon-separated list of user IDs with elevated permissions + +* Make sure your changes pass the linter before submitting them + + * The repo's husky hook should take care of it, but just in case keep its checks in mind \ No newline at end of file