Bring README template in line with Code Patterns Guide

ibm-watson-data-lab / shopping-list

A series of Offline First shopping list demo apps, each built using a different stack.

https://ibm-watson-data-lab.github.io/shopping-list/

68 stars 20 forks source link

Bring README template in line with Code Patterns Guide #97

Closed lornajane closed 6 years ago

lornajane commented 6 years ago

Fixes #96 by following the guidelines at https://pages.github.ibm.com/developer-journeys/journey-docs/dev/README/ and borrowing heavily from Patrick's README in the polymer/PouchDB shopping list project.

bradley-holt commented 6 years ago

Looks great to me! Some minor notes:

The "install the prerequisites" section contains Polymer-specific content.
The "one good way to test this is to run two browsers" note assumes this is a web app, though some of the apps are native, hybrid, or desktop apps.
Similarly, the "Disabling Deployment Tracking" section assumes that this is a web app.

lornajane commented 6 years ago

The template from the Code Pattern Guide has the content from another project; I left in Patrick's content since I thought we were more likely to reuse that than something from an unrelated project, but I can either remove it entirely or switch to the supplied example content if either of those seem more useful?

bradley-holt commented 6 years ago

I think it's OK. I'd say we just leave it.

I'll go ahead and merge this.