Skip to content

Commit 4e3f009

Browse files
docs: update README
1 parent 1455538 commit 4e3f009

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
- [Table of Contents](#table-of-contents)
77
- [Pre-requisites:](#pre-requisites)
88
- [Consuming Unity packages in your separate project:](#consuming-unity-packages-in-your-separate-project)
9-
- [How to use the private package registry:](#how-to-use-the-private-package-registry)
9+
- [If you want to clone the entire repository and work on the packages:](#if-you-want-to-clone-the-entire-repository-and-work-on-the-packages)
1010
- [TROUBLESHOOTING ERRORS](#troubleshooting-errors)
1111
- [Packages in this repository](#packages-in-this-repository)
1212
- [Cookie Consent](#cookie-consent)
@@ -68,19 +68,30 @@ Follow the steps below if you want to consume the Unity packages in your own pro
6868
2. Install the package using npm:
6969
```npm install @asu/<package-name>```
7070

71-
If using yarn2+, follow the steps below.
71+
If using yarn2+:
72+
73+
1. Add the following to your .yarnrc.yml file:
74+
```Yaml
75+
npmScopes:
76+
asu:
77+
npmAuthToken: "${GITHUB_AUTH_TOKEN-fallback}"
78+
npmPublishRegistry: "https://npm.pkg.github.com"
79+
npmRegistryServer: "https://npm.pkg.github.com"
80+
```
81+
2. Add the following to your .env.yarn file:
82+
```env
83+
GITHUB_AUTH_TOKEN=YOUR_AUTH_TOKEN_HERE
84+
```
7285

7386

74-
## How to use the private package registry:
87+
## If you want to clone the entire repository and work on the packages:
7588

7689
The ASU Unity Design System packages are published to GitHub's package registry. This is not the same as the NPM registry. To use the packages, you need to belong to ASU's GitHub organization and to configure your local NPM to use this registry.
7790

7891
1. Clone the monorepo using ```git clone``` or download the zip file from GitHub.
7992
2. If you don't already have it [request access to the Unity Design System GitHub Repo](https://asu.edu/webservices).
8093
3. Once you have access, there is a ```.env.yarn.example``` file in the root of this project with the correct environment variable name used in the ```.yarnrc.yml``` file. Make a copy and name it ```.env.yarn``` and replace the ```YOUR_AUTH_TOKEN_HERE``` with a [GitHub Personal Access Token](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-to-github-packages) to have a project-based configuration for adding Unity package dependencies to your project.
8194
4. The environment variable in the ```.env.yarn``` file is used in the ```.yarnrc.yml``` file to authenticate with the GitHub package registry. The ```.yarnrc.yml``` file is used by Yarn to configure the package registry.
82-
5. Test installing packages using yarn or npm inside of another NPM project:
83-
```yarn add @asu/unity-bootstrap-theme```
8495

8596
### TROUBLESHOOTING ERRORS
8697

@@ -131,7 +142,7 @@ Previously deprecated packages were located inside the `packages-disabled` folde
131142
6. [app-new-template](https://github.com/ASU/asu-unity-stack/tree/86368e5c656108169fe27cbc405e43c2cebae968/packages-disabled/app-new-template)
132143
7. [component-forms](https://github.com/ASU/asu-unity-stack/tree/86368e5c656108169fe27cbc405e43c2cebae968/packages-disabled/component-forms)
133144
8. [maps](https://github.com/ASU/asu-unity-stack/tree/86368e5c656108169fe27cbc405e43c2cebae968/packages-disabled/maps)
134-
9. component-carousel
145+
9. [component-carousel](https://github.com/ASU/asu-unity-stack/blob/b5cc906aa26148208a0458355b9bf6d2f6bec149/packages/component-carousel/package.json)
135146

136147

137148
## Package Multi Output Targets

0 commit comments

Comments
 (0)