From 7f9151caf3944848afddd7b663ba2f3056a0bd35 Mon Sep 17 00:00:00 2001
From: alisonmyers <alison.myers@ubc.ca>
Date: Wed, 22 May 2024 13:16:39 -0700
Subject: [PATCH] changes from review

---
 README.md | 23 +++++++++++++----------
 1 file changed, 13 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index e580fd1..6cf6412 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 # Canvas Discussion
-This project pulls via the Canvas API the discussions from the specified Canvas course and exports it as CSV. The columns exported are:
+This project pulls data via the Canvas API the discussions for the specified Canvas course(s) and exports the results as CSV. The columns exported are:
 * 'topic_id',
 * 'topic_title',
 * 'topic_message',
@@ -30,16 +30,19 @@ These instructions will get you a copy of the project up and running on your loc
 1. Clone this repo. `git clone https://github.com/ubccapico/canvas-discussion.git`
 1. Then cd into the repo. `cd canvas-discussion`
 1. Run the installation script. `npm install` (If you see `babel-node: command not found`, you've missed this step.)
-1. Generate Canvas API token and copy it to clipboard.
+1. Generate Canvas API token and copy it to clipboard
+    > - See [Get Started with the Canvas API](https://learninganalytics.ubc.ca/guides/get-started-with-the-canvas-api/) for more information.
+    > - ⚠️ Your Canvas API token is the equivalent to your username and password and must be treated as such (following any security guidelines of your home institution).
 1. Create a `.env` file.
-1. Add the following: `CANVAS_API_TOKEN={YOUR API TOKEN}`, `CANVAS_API_DOMAIN={YOUR API DOMAIN}`, `COURSE_IDS={YOUR COURSE ID(s)}`. At UBC the `CANVAS_API_DOMAIN` is `https://{school}.instructure.com/api/v1`
-
-Your .env file should look like
-```
-CANVAS_API_TOKEN=22322...
-CANVAS_API_DOMAIN=https://{school}.instructure.com/api/v1
-COURSE_IDS=1111,1112
-```
+1. Add the following: `CANVAS_API_TOKEN={YOUR API TOKEN}`, `CANVAS_API_DOMAIN={YOUR API DOMAIN}`, `COURSE_IDS={YOUR COURSE ID(s)}`. > - At UBC the `CANVAS_API_DOMAIN` is `https://ubc.instructure.com/api/v1`
+    > - At another institution it might be something like `https://{school}.instructure.com/api/v1`
+
+    Your .env file should look like
+    ```
+    CANVAS_API_TOKEN=22322...
+    CANVAS_API_DOMAIN=https://ubc.instructure.com/api/v1
+    COURSE_IDS=1111,1112
+    ```
 1. Run the script. `npm start`.
 1. A `{course_id}-discussion.csv` file should be generated with discussion data in the output folder for each provided course_id.