comingle-attendance - npm Package Compare versions

Comparing version 0.0.0 to 0.0.1

package.json

		{
		"name": "comingle-attendance",
		"version": "0.0.0",
		"version": "0.0.1",
		"description": "Attendance measurement for Comingle meetings",
		@@ -5,0 +5,0 @@ "main": "index.js",

README.md

		@@ -21,16 +21,43 @@ # Comingle Attendance Tracking

		## Usage
		## Configuration

		To run this script from a Git repo clone, do the following:
		To use this tool, you need to create your own configuration file,
		say `config.coffee` (or name it to match your meeting or class).
		Start from a copy of
		[`template.coffee`](https://github.com/edemaine/comingle-attendance/blob/main/template.coffee),
		which describes the various options you can set.

		1. `npm install`
		2. Copy `template.coffee` to `config.coffee` (or some other filename, e.g.,
		`my-class.coffee`).
		3. Edit `config.coffee` to fill in the specifics for your meeting:
		* In particular, set the `server` URL, the `meeting` ID,
		and the meeting `secret`; and add `events` you want to track.
		* Read [`template.coffee`](https://github.com/edemaine/comingle-attendance/blob/main/template.coffee)
		for descriptions of the various options.
		* Do not commit your config file into Git (or change `template.coffee`),
		or risk your meeting and its secret leaking to the world.
		4. `npm run attendance config.coffee`
		In particular, you should set the `server` URL, the `meeting` ID,
		the meeting `secret`, and list `events` that you want to track.

		Alternatively, you can use a `.js` configuration file.
		In either case, the last expression in this file should evaluate to an object
		with configuration options.

		Do not commit your config file into Git (or change `template.coffee`),
		or risk your meeting and its secret leaking to the world.

		## Running the Script

		To run this tool on any machine with [NodeJS](https://nodejs.org/) installed,
		do one of the following from the command line:

		1. Via `npx`:
		```sh
		npx comingle-attendance config.coffee
		```
		2. Install globally once:
		```sh
		npm install -g comingle-attendance
		```
		Thereafter use:
		```sh
		comingle-attendance config.coffee
		```
		3. Run from a Git clone:
		```sh
		git clone https://github.com/edemaine/comingle-attendance.git
		cd comingle-attendance
		npm install
		npm run attendance config.coffee
		```

comingle-attendance - npm Package Compare versions

Improved metrics