canvas-grade-uploader - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

cli.js

@@ -101,3 +101,3 @@ #! /usr/bin/env node
 // Specify encoding to return a string
-gradesFile = fs.readFileSync(ARG_VALS['grades-csv'], { encoding: 'utf8'});
+gradesFile = fs.readFileSync(ARG_VALS.file, { encoding: 'utf8'});
 
@@ -104,0 +104,0 @@ postGrades(ARG_VALS, gradesFile, console.log);

package.json

 {
   "name": "canvas-grade-uploader",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Upload a CSV file of grades to Canvas",
@@ -5,0 +5,0 @@ "main": "./uploader.js",

README.md

@@ -7,2 +7,9 @@ # Canvas Grade Uploader
 
+## Installation
+The grade uploader works well as a command line tool. If you're using it this way be sure to use the `-g` option:
+```
+npm install -g canvas-grade-uploader
+```
+
+
 ## Usage
@@ -30,7 +37,35 @@ There are two use cases:
 ## Configuration
+The grade uploader uploads grades to a specific Canvas assignment. To do this a few details are required. The command line help will walk you through most of them.
 
+Canvas assignment and course IDs are easily obtained from the URL of the assignments page.
+
+For example:
+```
+https://bcourses.berkeley.edu/courses/1268501/assignments/7148451
+```
+
+* URL: `https://bcourses.berkeley.edu/`
+* Course ID: `1268501`
+* Assignment ID: `7148451`
+
 ### Getting a Canvas Token
+Canvas authenticates users with Oauth Tokens. You can generate a token for yourself by visiting your personal settings page. There is Canvas [documentation][docs] about generating your own token.
 
+The short version is: Visit this page.
+`https:/<canvas-instance>/profile/settings`
+
+[docs]: https://guides.instructure.com/m/4214/l/40399-how-do-i-obtain-an-api-access-token-for-an-account
+
 ## CSV Format
+This tool was built to speed up working with [Gradescope](https://gradescope.com)
 
-## Default Values
+The CSV file requires the following values:
+
+* SID
+* Total Score
+
+## Default Values
+
+## Options and Callback Formats
+
+## Tips

No alert changes

Improved metrics

Total package byte prevSize

9678

increased by13.87%

Number of lines in readme file

69

increased by102.94%

No dependency changes