From 88d667402f1b0a2ba42e74701cf52c0dee14c6af Mon Sep 17 00:00:00 2001 From: Steven Conaway Date: Wed, 30 Dec 2020 17:35:17 -0800 Subject: [PATCH] Add a bit more instructions to the README --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index adf7f2a..9a80dab 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,15 @@ This is an app for the #counttoamillion channel in Hack Club's Slack workspace, where you and a team of other cool kids together try to count to a million, base ten, by ones. No one can count consecutively. No purpose, just a fun team-building game :) Every midnight, the bot gives a report on the progress the channel's made and the average daily speed: -![a couple of messages from different people showing numbers going the day's increase, the average daily speed, and the predicted amount of time needed to reach the next thousand/tenthousand](./counttoamillion.png) +![a couple of messages from different people showing numbers going the day's increase, the average daily speed, and the predicted amount of time needed to reach the next thousand/ten thousand](./counttoamillion.png) ## Modifying this thing - `app.js` contains the primary Bolt app. It imports the Bolt package (`@slack/bolt`) and starts the Bolt app's server. -- `.env` is where you'll put your Slack app's authorization token and signing secret. +- `.env` is where you'll put your [Slack app's authorization token and signing secret](https://slack.dev/bolt-js/tutorial/getting-started#tokens-and-installing-apps) and your [Airtable API key](https://support.airtable.com/hc/en-us/articles/219046777-How-do-I-get-my-API-key-). + +## Packages used -### Packages used: - [moment.js](https://momentjs.com/) - [node-schedule](https://www.npmjs.com/package/node-schedule) - [Slack's Bolt API](https://slack.dev/bolt-js/tutorial/getting-started)