Update README; add config.yaml.example

Author: BigBlueHat

.gitignore

@@ -1,3 +1,4 @@
 node_modules/
+config.yaml
 people.json
 publish.sh

README.md

@@ -28,20 +28,11 @@ Scrawl works on directories structured like:
 The output files will be added to the same directory for simpler hosting of
 all the things.
 
-Now, we need to setup the nicknames of all the people in the group.
-So, copy `people.json.example` to `www/people.json` and fill in names,
-homepages, and nicknames as needed.
+There are **two** important setup files:
+ - `config.yaml` (see `config.yaml.example`)
+ - `people.json` (see `people.json.example`)
 
-To edit logs in a Web page, it's recommended to install the `http-server` node
-package and use that (for now):
-
-```sh
-$ npm i -g http-server
-$ http-server www/
-```
-
-Once that's done, you can visit `http://localhost:8080/` to paste IRC logs, see
-the output, and copy/paste the HTML (etc) wherever you need it.
+Once those two files are configured to your contentment, see below.
 
 ## Command Line Usage
 
@@ -96,6 +87,21 @@ The WordPress, Google, and Twitter related switches also require some custom
 environment variables to be setup. For examples of those, see the
 [publish.sh.example](publish.sh.example).
 
+## Web-based editor
+
+You can edit logs in a small Web app. To do so, it's recommended to install the
+`http-server` node package and use that (for now):
+
+```sh
+$ npm i -g http-server
+$ http-server www/
+```
+
+Once that's done, you can visit `http://localhost:8080/` to paste IRC logs, see
+the output, and copy/paste the HTML (etc) wherever you need it.
+
+For this to work you'll need to put `people.json` in your `www/` folder.
+
 ## Wrapping bash scripts
 
 If you're on a machine that has bash available, there are a couple useful tools

config.yaml.example

@@ -0,0 +1,49 @@
+---
+# required - or URLs are not produce-able
+minutes_base_url: https://json-ld.github.io/minutes/
+
+group: JSON-LD CG Telecon # default: Telecon
+people: www/people.json # default: www/people.json
+partials: www/_partials/ # default: www/_partials/
+
+# The `content` and `minutes_base_url` Mustache variables MUST are pre-escaped
+# so use {{{content}}} (3 curley braces) to properly unescape them for text.
+
+email: # required for -e
+  from: gregg@greggkellogg.net # required!
+  to: JSON-LD CG <public-linked-json@w3.org> # required!
+  # Mustache template - vars: gDate
+  subject: "[MINUTES] W3C JSON-LD CG Call - {{gDate}} 12pm ET"
+  # Mustache template - vars: content, gDate, scribe, minutes_base_url
+  body: |-
+    Thanks to {{scribe}} for scribing this week! The minutes
+    for this week's JSON-LD CG telecon are now available:
+    {{{minutes_base_url}}}{{gDate}}/
+
+    Full text of the discussion follows for W3C archival purposes.
+    Audio from the meeting is available as well (link provided below).
+
+    ----------------------------------------------------------------
+    {{{content}}}
+gplus: # required for -g
+  # Mustache template - vars: content, formattedItems, gDate, minutes_base_url
+  body: |-
+    *JSON-LD CG Meeting Summary for {{gDate}}*
+
+    We discussed {{formattedItems}}.
+
+    {{{content}}}
+
+    Full transcript and audio logs are available here:
+
+    {{{minutes_base_url}}}{{gDate}}/
+
+    #w3c #json-ld
+twitter: # required for -t
+  # Mustache template - vars: group, message, gDate, minutes_base_url
+  body: |-
+    JSON-LD CG discusses {{message}}:
+    {{{minutes_base_url}}}{{gDate}}/ #w3c #json-ld
+wordpress: # required for -w
+  # Mustache template - vars: gDate
+  title: "JSON-LD CG Meeting Minutes for {{gDate}}"