diff --git a/README.md b/README.md index 8ce3c0b..c74600b 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,31 @@ A Slack/Discord bot integration with NASA data. This is a Slack/Discord bot that is designed to use the NASA APOD API to allow users to query the API through Slack or Discord. + +## Table of contents + +[Project structure](#project-structure) + +[Installation](#installation) + +[Configuration](#configuration) + +[Technologies used](#technologies-used) + +## Project structure + +```` +|- astroBotDiscord.js ______________________ # Discord application entry +|- astroBotSlack.js ________________________ # Slack application entry +|- config.json _____________________________ # Application config file +|- Procfile ________________________________ # Heroku deployment config +```` + +## Installation +### Discord + +### Slack + +## Configuration + +## Technologies used