Skip to content

Update readme #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pipwilson wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update readme #147

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,14 @@ The application expects to have access to a Google Doc with the text for the abo
* ``key``
* ``value``

We require values for the following keys:

* ``title`` - screenreader-only text used as the main page title
* ``question`` - used as a header above the filters
* ``chatter`` - some prose displayed above the filters
* ``socialTitle`` - used in the `<title>` element
* ``socialDescription`` - used in the `<meta name="description">` element

* **links** - related story links for each book

* ``year`` - year for the book
Expand All @@ -135,6 +143,7 @@ The application expects to have access to a Google Doc with the text for the abo

* ``id`` - primary key for the book, used for permalinks and table relationships
* ``title``
* ``author``
* ``reviewers`` - an array of comma separated names should match keys in the reviewer sheet
* ``text`` - recommendation blurb
* ``tags`` - filter categories, separated by ``|`` characters
Expand Down