Skip to content

Commit 7d60a4b

Browse files
committed
cleanup the readme
1 parent 8a87d23 commit 7d60a4b

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

README.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ A React component library intended for use with WebStore applications.
33

44
## Table of Contents
55

6+
- [How To Install This Library](#how-to-install-this-library)
67
- [Getting started](#getting-started)
78
- [NPM version](#npm-version)
89
- [Running the app](#running-the-app)
@@ -12,8 +13,17 @@ A React component library intended for use with WebStore applications.
1213
- [Linting](#linting)
1314
- [Using Icons](#using-icons)
1415
- [Building the library](#building-the-library)
16+
- [Cutting a New Release](#cutting-a-new-release)
1517

1618
---
19+
20+
## How To Install This Library
21+
``` bash
22+
yarn add @scientist-softserv/webstore-component-library
23+
# OR
24+
npm install @scientist-softserv/webstore-component-library
25+
```
26+
1727
## Getting started
1828
### NPM version
1929
Use NPM version `v8.19.2` and please do not mix it with Yarn.
@@ -27,7 +37,7 @@ Use NPM version `v8.19.2` and please do not mix it with Yarn.
2737
- A new browser tab will automatically open to "http://localhost:6006/"
2838

2939
#### Troubleshooting
30-
- If you see the following when starting the app:
40+
- If you see the following when starting the app:
3141
- `Error: error:0308010C:digital envelope routines::unsupported`
3242
- set the following env variable in your local shell: `export NODE_OPTIONS=--openssl-legacy-provider`
3343

@@ -102,7 +112,7 @@ This project uses [fontawesome's free solid icons](https://fontawesome.com/searc
102112
```
103113

104114
#### Troubleshooting Icons
105-
- If the expected icon doesn't show up, use the link provided above to search for it again. Click on the icon and confirm that the string in the example matches the camelcase variable that was imported and the string that was used with the "icon" prop.
115+
- If the expected icon doesn't show up, use the link provided above to search for it again. Click on the icon and confirm that the string in the example matches the camel cased variable that was imported and the string that was used with the "icon" prop.
106116
107117
## Building the library
108118
We are using Rollup JS to build and publish the library. The scripts will build based on the contents of "src/index.js" so make sure that any newly created components are referenced in the appropriate "components/index" or "compounds/index" files.
@@ -114,16 +124,15 @@ npm run watch-lib # use when you want to build the library for local use; it wil
114124
## Cutting a New Release
115125
A git tag should exist for every release. We use `release-it` to automate the coordination of package.json and git tag.
116126
117-
If you want to release a new semver release run:
118-
119-
npm run release
120-
(You will be prompted to select a release type, e.g. patch)
121-
122-
And be sure to say yes to all the prompts, you want a commit, you want a tag, and you want to push up to github.
123-
124-
## Teaching Yarn How To Install This Library
125-
126-
yarn add @scientist-softserv/webstore-component-library@https://github.com/scientist-softserv/webstore-component-library
127+
If you want to release a new semver release run `npm run release`. You'll be entered into an interactive session with the following prompts:
128+
``` bash
129+
? Select increment (You will be prompted to select a release type, e.g. patch)
130+
? Publish @scientist-softserv/webstore-component-library to npm? (Yes)
131+
? Please enter OTP for npm: (This is stored in 1password)
132+
? Commit (chore: release vX.X.X)? (Yes)
133+
? Tag (X.X.X)? (Yes)
134+
? Push? (Yes)
135+
```
127136

128137
## Authors and acknowledgment
129138
Alisha Evans

0 commit comments

Comments
 (0)