Skip to content
This repository was archived by the owner on May 7, 2025. It is now read-only.

Commit 6d45423

Browse files
author
Emanuel Suriano
committed
docs: adjust readme commands
1 parent 579f4dc commit 6d45423

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

README.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -143,28 +143,38 @@ const App = () => (
143143
| `children` | `ReactNode` | false | null | Section content |
144144
| `id` | `string` | true | - | Section ID |
145145

146-
## Contributing
146+
## Contributing 🧑‍💼
147147

148-
### Setup project
148+
I'm always open for suggestions and improvements, so don't hesitate to open an Issue or new Pull Request.
149149

150-
- Running `yarn install` in the component's root directory will install everything you need for development.
150+
### Setup project
151151

152-
### Demo Development Server
152+
This project is using Yarn workspace, therefore check that you have Yarn as your package manager.
153153

154-
- `yarn start`: starts the development server with the component's demo app at [http://localhost:3000](http://localhost:3000).
154+
```sh
155+
# Check if you have you Yarn install
156+
> yarn -v
157+
1.22.18
155158

156-
### Testing
159+
# Install dependencies
160+
> yarn
161+
```
157162

158-
- `yarn test`: executes Cypress and run test. Remember to execute `yarn start` in order to have a successful result.
159-
- `yarn test:open`: opens Cypress interface which allows you to execute test individually and preview the order execution of the tests.
163+
### Commands
160164

161-
### Building
165+
```sh
166+
# Builds library
167+
> yarn build
162168

163-
- `yarn build`: builds the library, this is necessary to be published to npm.
169+
# Starts demo app locally
170+
> yarn start
164171

165-
## Contribute ❤️
172+
# Run E2E tests
173+
> yarn test
166174

167-
I'm always open for suggestions and improvements, so don't hesitate to open an Issue or new Pull Request 😁
175+
# Build library + demo app
176+
> yarn build:demo
177+
```
168178

169179
## License 🔖
170180

0 commit comments

Comments
 (0)