Skip to content

readme: installation instructions #12

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.

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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