Issue 15 - adds initial how-to-contribute / overview text (#32)

* issue-15: updates readme, updates/adds intro content

* issue-15 - fixes typos, adds clarifying text

* issue-15 - adds setup text to README

README.md

@@ -1,7 +1,20 @@
 # FE-resource-library
-Front end resource library
+## 🛠️ The CivicActions Front End Resource Library
 
+The primary goal of this repo is to house shared knowledge and resources that support:
+
+1. The setup and expansion of project workflows with best practices in mind
+2. Documenting approaches, recipes, and best practices for common issues and requriements
+3. The general growth and advancement of the Front End practice area at CivicActions
+
+The secondary goal of this repo is to create an npm package(s) of common components, hooks, baseline styling, and other settings and configurations that will support the setup of various projects.
+
+## Setup
+This resource library is built using [Storybook](https://storybook.js.org/). All of the content is maintained by the engineers in the front end practice area at CivicActions.
+
+We selected Storybook as the basis for this library in order to enable a more straightforward approach to contributing and documenting shared knowledge and resources.
 ## Commands
+- `npn install` to install all packages.
+- `npm run storybook` will create a Storybook instance at `localhost:6006`.
 - `npm test` will run the complete test suite.
 - `npm run build` will run Webpack and build the dist file.
-- `npm run storybook` will create a Storybook instance at `localhost:6006`.

src/documentation/about/01-welcome.stories.mdx

@@ -0,0 +1,21 @@
+import { Meta } from '@storybook/addon-docs';
+
+<Meta title="Welcome" />
+
+# About This Resource Library
+
+## Goals
+
+The primary goal of this repo is to house shared knowledge and resources that support:
+
+1. The setup and expansion of project workflows with best practices in mind
+2. Documenting approaches, recipes, and best practices for common issues and requriements
+3. The general growth and advancement of the Front End practice area at CivicActions
+
+The secondary goal of this repo is to create an npm package(s) of common components, hooks, baseline styling, and other settings and configurations that will support the setup of various projects.
+
+## Setup
+
+This resource library is built using [Storybook](https://storybook.js.org/). All of the content is maintained by the engineers in the front end practice area at CivicActions.
+
+We selected Storybook as the basis for this library in order to enable a more straightforward approach to contributing and documenting shared knowledge and resources.

src/documentation/about/02-how-to-contribute.stories.mdx

@@ -0,0 +1,37 @@
+import { Meta } from '@storybook/addon-docs';
+
+<Meta title="How To Contribute" />
+
+# How to contribute
+
+## General Documentation
+
+General documentation pages focus on sharing best practices, recipes/examples, etc., and are meant to be read from the [Github Pages instance](https://civicactions.github.io/FE-resource-library/) of the CivicActions Resource Library. They will not be distributed as part of an NPM package.
+
+Providing documentation is easy! This Storybook instance includes the [Docs addon](https://storybook.js.org/addons/@storybook/addon-docs), which allows you to write long-form markdown documentation and stories in one file, or just pure documentation pages using the `.mdx` format. [MDX](https://mdxjs.com/) is a standard file format that combines Markdown with JSX. Although this means you can freely embed JSX component blocks at any point in the file, general documentation pages will usually just consist of content written in Markdown only.
+
+### Guidelines
+
+- Your file should be saved under the `src/documentation` directory.
+- Files should be named with the full `.stories.mdx` suffix and file format.
+- See existing documentation files for an example of how to format the file.
+- Use the value for the `title` prop in the `<Meta>` component to dictate where your page lives in Storybook's left-side navigation.
+- Files will display alphabetically in the left-side menu. Use the file name to control the order in which your files will display.
+```
+📂 src
+ 📂 documentation
+  📂 my-subject
+    📄 01-some-topic.stories.mdx
+    📄 02-another-topic.stories.mdx
+```
+
+## Components, Hooks, and other code examples
+
+_More information coming soon._
+
+## Workflow
+
+- Whether you have an idea for a new general documentation or a component or hook you want to share, create an issue for your idea and follow the issue guidelines _(coming soon)_ for creating a new contribution.
+- Make your changes in a feature branch off the of the latest `main` branch, and follow the GitHub workflow guidelines for naming your branch so that it is synced to the issue you created.
+- Once you're ready, create a pull request for your branch targeting the main branch and it will be reviewed by the team.
+- Once your branch is merged it will be available on the github pages instance after the build tasks complete.