@raspberrypifoundation/design-system-react 0.1.3

package/README.md

@@ -0,0 +1,50 @@
+# Design System React
+
+## Usage
+
+### Using a local running NPM
+
+`design-system-react` is published to the GitHub package registry and is dependent on `design-system-core`.
+
+Installation of `design-system-core` requires a user-level `~/.npmrc` file that contains a GitHub access token.
+
+Follow the steps in the `design-system-core` [README](https://github.com/RaspberryPiFoundation/design-system-core) to create a token and set up a local version of that project.
+
+You should have:
+
+- generated a token via the GitHub website: it will typically be prefixed with "ghp"; and
+- created a file called `.npmrc` in your user root directory (not the directory of this project) that contains the following:
+  `//npm.pkg.github.com/:_authToken={GITHUB_TOKEN}`
+
+Once that's complete, use `npm` - not `yarn` - to install this package.
+
+```
+npm i
+
+npm run storybook
+```
+
+### Adding design-system-react to a project
+
+Projects that need to import this package must have an `.npmrc` file at their root level. The file should contain:
+
+```
+# Sets GitHub as the registry for packages scoped to @RaspberryPiFoundation
+@raspberrypifoundation:registry=https://npm.pkg.github.com
+```
+
+`design-system-react` can then be installed using the project's package manager.
+
+### Deployment
+
+Create a new [release](https://github.com/RaspberryPiFoundation/design-system-react/releases):
+
+- click 'Draft a new release'
+- type the version in the dropdown and click 'Create new tag'
+- add a title and some notes about what the release contains
+- click 'Publish release' (leave 'Set as latest release' checked) and a build will be kicked off
+- add new version to `package.json` in your app
+
+### Using Docker
+
+TODO