Skip to content

Commit bd011a4

Browse files
authored
Updated README.md with new instructions
1 parent f58bfd0 commit bd011a4

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,22 @@ Check out our [website](https://hackncstate.org/).
99

1010
## How to add announcements for a new year
1111

12-
1. `./src/events/` - add your csv file with a list of all announcements to this folder (make sure to follow the template with proper column names)
13-
2. `./src/config.js` - update the file name
14-
3. `./src/config.js` - update the channel id
12+
1. Create a google sheet with a list of announcements with the following columns:
13+
```
14+
date time type title description location eventTime URL thumbnailURL imageURL
15+
```
16+
2. the code will only read in the range `A2:J`, if you want to add more info columns, update this in the code
17+
3. location, time, and URLs are optional
18+
4. Copy the sheets ID (the part of the URL after `https://docs.google.com/spreadsheets/d/` and before `/edit`)
1519

1620
---
1721

1822
## How to run the bot
1923

2024
1. clone the repo locally
21-
2. edit the `.env.example` file by adding the bot token and renaming to `.env`
22-
3. in a terminal, run `npm run start` or `npm run dev`(if you're actively developing)
25+
2. edit the `.env.example` file by adding the bot token and renaming it to `.env`
26+
3. create a Google Cloud application and enable the sheets API, download the auth file, and place it in the repo; add this location in the config.
27+
4. edit the `src/config.js` to replace the `sheetsID` and the `announcementsChannelID`
28+
5. in a terminal, run `npm run start` or `npm run dev` (if you're actively developing)
2329

2430
---

0 commit comments

Comments
 (0)