Skip to content

Commit

Permalink
fix: begin fixing readme (#954)
Browse files Browse the repository at this point in the history
Co-authored-by: Ciarán Curley <[email protected]>
  • Loading branch information
DogPawHat and Ciarán Curley authored Sep 27, 2022
1 parent 26c8266 commit 7ab8ef9
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,24 +15,24 @@ Then, run these commands:
```
git clone [email protected]:reach/reach-ui.git
cd reach-ui
yarn install
yarn build
pnpm install
pnpm build
```

## Root Repo Scripts:

```sh
yarn build # builds all packages
yarn start # starts storybook server
yarn test # runs tests in all packages
pnpm build # builds all packages
pnpm dev # starts storybook server
pnpm test # runs tests in all packages
```

## Running / Writing Examples

First do the steps in "Getting started", then start the Storybook server:

```
yarn start
pnpm dev
```

Next, put a file in `packages/<component-dir>/examples/<name>.example.js` and make it look like this:
Expand Down Expand Up @@ -65,20 +65,20 @@ Now you can edit the files in `packages/*` and storybook will automatically relo
First do the steps in "Getting Started", then:

```
yarn test
pnpm test
```

Or if you want to run the tests as you edit files:

```
yarn test --watch
pnpm test --watch
```

Often you'll want to just test the component you're working on:

```
cd packages/<component-path>
yarn test --watch
pnpm test --watch
```

## Development Plans
Expand Down Expand Up @@ -106,9 +106,9 @@ The components to be built come from the the [Aria Practices Design Patterns and
| 🛠 | Toggletip |
|| Tooltip |

## Releases
## Releases [DEPRECATED]

This is our current release process. It's not perfect, but it has almost the right balance of manual + automation for me. We might be able to put some of this in a script...
This is (was?) our current release process. It's not perfect, but it has almost the right balance of manual + automation for me. We might be able to put some of this in a script...

```sh
# First, run the build locally and make sure there are no problems
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"url": "git+https://github.com/reach/reach-ui.git"
},
"scripts": {
"preinstall": "npx -y only-allow pnpm",
"build": "turbo run build --filter=@reach/* && node scripts/postbuild.js",
"test:react-16": "USE_REACT_16=true vitest",
"test:react-18": "USE_REACT_18=true vitest",
Expand Down

0 comments on commit 7ab8ef9

Please sign in to comment.