@raspberrypifoundation/design-system-react 1.1.15 → 1.2.0

package/README.md

@@ -2,40 +2,51 @@
 
 ## Usage
 
-### Using a local running NPM
+Using `npm`:
 
-`design-system-react` is published to the GitHub package registry and is dependent on `design-system-core`.
+```bash
+npm install @raspberrypifoundation/design-system-react
+npm run storybook
+```
 
-Installation of `design-system-core` requires a user-level `~/.npmrc` file that contains a GitHub access token.
+Using `yarn`:
 
-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.
+```bash
+yarn install @raspberrypifoundation/design-system-react
+yarn storybook
+```
 
-You should have:
+### Working with a local version of [design-system-core](https://github.com/RaspberryPiFoundation/design-system-core)
 
-- 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}`
+Sometimes you may want to work on `design-system-core` and `design-system-react` at the same time. You can do this by working with your local version of core using `npm link`.
 
-Once that's complete, use `npm` - not `yarn` - to install this package.
+1. Navigate to your local `design-system-core` repo create a global symbolic link.
 
 ```
-npm i
-
-npm run storybook
+npm link
 ```
 
-### Adding design-system-react to a project
+2. In `design-system-react` remove the node_modules folder and install the application.
 
-Projects that need to import this package must have an `.npmrc` file at their root level. The file should contain:
+```
+rm -rf node_modules && npm i
+```
+
+3. Navigate to your local `design-system-react` repo and tell the application to use the global symbolic link. You should notice "changed 1 package" in the response.
 
 ```
-# Sets GitHub as the registry for packages scoped to @RaspberryPiFoundation
-@raspberrypifoundation:registry=https://npm.pkg.github.com
+npm link @raspberrypifoundation/design-system-core
 ```
 
-`design-system-react` can then be installed using the project's package manager.
+#### Troubleshooting
+
+If you are experiencing issues and believe design-system-react is not using your local version of design-system-core, or if you are running into issues running `npm link`, try the following:
+
+- Check that `design-system-react` and `design-system-core` are both using the same `nodejs` version in `.tool_versions`. If they are not, update the node version(s) in `.tool_versions` locally and retry the steps above. If this was the issues / the `nodejs` versions are not the same, consider creating a PR to bring them in-line.
+
+- Ensure that you are running the `npm link` command in step 3 AFTER step 2. Doing these in the wrong order will not work.
 
-### Deployment
+## Deployment
 
 Create a new [release](https://github.com/RaspberryPiFoundation/design-system-react/releases):
 
@@ -46,6 +57,6 @@ Create a new [release](https://github.com/RaspberryPiFoundation/design-system-re
 - 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
+## Using Docker
 
 TODO