Merge branch '584-README-rename-0.2' into release/1.0.3-ahjumawi

.eleventyignore

@@ -2,7 +2,7 @@
 .husky
 test
 components/index.html
-components/readme.md
+components/README.md
 components/*/*.(json|html|js|css|scss)
 components/*/*/**/*
 package.json

CHANGELOG.md

@@ -30,4 +30,4 @@
 
 ## 1.0.0
 
-- Initial release includes 18 components, principles, get started documentation, contact forms, design and content style guides. The component documentation is dynamically built from the component's readme doc and includes live interactive demos of the component.
+* Initial release includes 18 components, principles, get started documentation, contact forms, design and content style guides. The component documentation is dynamically built from the component's README doc and includes live interactive demos of the component.

README.md

@@ -31,10 +31,10 @@ To run this project locally, checkout this repo and run these commands:
 
 This will start up a local server running the site you see at <a href="https://designsystem.webstandards.ca.gov">designsystem.webstandards.ca.gov</a>.
 
-You can find the components in the `/components` directory. The readme for each component is used to create the pages in the <a href="https://designsystem.webstandards.ca.gov/components/">Components section</a>. Interactive versions of each component are included in these pages.
+You can find the components in the `/components` directory. The README for each component is used to create the pages in the <a href="https://designsystem.webstandards.ca.gov/components/">Components section</a>. Interactive versions of each component are included in these pages.
 
 Each component is published to npm. The following steps are run in a pre-publish hook in the package.json script. New versions will not publish unless these steps complete:
-- The sample markup in the readme is matched to the sample markup used in the automated test
+- The sample markup in the README is matched to the sample markup used in the automated test
 - Any build steps like JavaScript concatenation or Sass compilation are run and resulting files are stored in the /dist folder
 - Automated tests are run including an axe accessibility checker
 - The latest version of the component is written to our CDN so it can be included with a script tag

components/link-icon/CONTRIBUTORS.md

@@ -7,15 +7,15 @@
 
 ### Verify
 
-- `npm run html:preview`  :  Update preview in design system website readme.
+- `npm run html:preview`  :  Update preview in design system website README.
 
 - `npm test` : Run automated accessibility test.
 
 ###  Publish 
 
 [See instructions at ODI wiki](https://github.com/cagov/odi-engineering/wiki/How-to-publish-a-package-to-npm) to publish to npm. You will need credentials to publish to npm and AWS. On npm publish the following scripts will run:
 
-- `npm run html:preview`  :  Update preview in design system website readme.
+- `npm run html:preview`  :  Update preview in design system website README.
 
 - `npm run build`  :  Compile CSS.
 

components/page-feedback/CHANGELOG.md

@@ -5,7 +5,7 @@
 * Changed name of custom element to `<cagov-page-feedback>`.
 
 ## 1.0.12
-* Remove unnecessary constructor, synch readme markup with test markup on publish
+* Remove unnecessary constructor, sync README markup with test markup on publish
 
 ## 1.0.11
 * Linted and formatted code per root eslint/prettier settings.

components/regulatory-outline/CONTRIBUTORS.md

@@ -7,15 +7,15 @@
 
 ### Verify
 
-- `npm run html:preview`  :  Update preview in design system website readme.
+- `npm run html:preview`  :  Update preview in design system website README.
 
 - `npm test` : Run automated accessibility test.
 
 ###  Publish 
 
 [See instructions at ODI wiki](https://github.com/cagov/odi-engineering/wiki/How-to-publish-a-package-to-npm) to publish to npm. You will need credentials to publish to npm and AWS. On npm publish the following scripts will run:
 
-- `npm run html:preview`  :  Update preview in design system website readme.
+- `npm run html:preview`  :  Update preview in design system website README.
 
 - `npm run build`  :  Compile CSS.
 

components/site-footer/CONTRIBUTORS.md

@@ -7,7 +7,7 @@
 
 ### Verify
 
-- `npm run html:preview`  :  Update preview in design system website readme.
+- `npm run html:preview`  :  Update preview in design system website README.
 
 - `npm test` : Run automated accessibility test.
 
@@ -18,7 +18,7 @@
 
 [See instructions at ODI wiki](https://github.com/cagov/odi-engineering/wiki/How-to-publish-a-package-to-npm) to publish to npm. You will need credentials to publish to npm and AWS. On npm publish the following scripts will run:
 
-- `npm run html:preview`  :  Update preview in design system website readme.
+- `npm run html:preview`  :  Update preview in design system website README.
 
 - `npm run build`  :  Compile CSS.
 

docs/pages/technical-approach.md

@@ -35,8 +35,8 @@ Learn how to [contribute or tell us your ideas](/contact-us/).
 
 ## Component installation
 
-The Design System components are individual packages that you can download. Each component has readme instructions for how to install it.
+The Design System components are individual packages that you can download. Each component has README instructions for how to install it.
 
 1. Browse the [components gallery](/components/).
 2. Choose the component you want.
-3. Follow the readme instructions to install.
+3. Follow the README instructions to install.

docs/src/publish/dynamic-html.js

@@ -1,6 +1,6 @@
 const fs = require('fs');
 
-const readmeFile = './readme.md';
+const readmeFile = './README.md';
 const htmlFile = './template.html';
 
 try {
@@ -25,6 +25,6 @@ ${markdownCodeDelim}
   fs.writeFileSync(readmeFile, finalReadme, 'utf8');
 } catch (e) {
   console.log(e);
-  // called from prepublish, exit if readme cannot be updated
+  // called from prepublish, exit if README cannot be updated
   process.exit(1);
 }