Skip to content

Commit

Permalink
Fixes #1457 - Refer to Yarn consistently in Clay README
Browse files Browse the repository at this point in the history
The Clay README instructs people to install and use Yarn, and we ship
with a yarn.lock, but we don't consistently use `yarn` in the commands
that we show in the README; this commit fixes that for consistency.

Tested the commands manually to make sure they all run as intended.

Related: https://issues.liferay.com/browse/IFI-421
  • Loading branch information
wincent committed Jan 21, 2019
1 parent 6b6e811 commit 2ccf4ac
Showing 1 changed file with 9 additions and 15 deletions.
24 changes: 9 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,31 +99,31 @@ If you want to contribute to this project and do not know where to start [good f
3. Install project dependencies:

```
yarn install
yarn
```

4. Install dependencies for each package and link them together:

```
npm run lerna
yarn lerna
```

5. Build all packages

```
npm run build
yarn build
```

6. Start a local server on port 4000

```
npm run start
yarn start
```

7. Run tests:

```
npm run test
yarn test
```

#### Clayui.com
Expand All @@ -137,29 +137,23 @@ cd clayui.com

2. Install dependencies:
```
yarn install
```

or

```
npm install
yarn
```

3. Run in development environment
```
npm run develop
yarn develop
```

If you want to test in a production environment so that you do not take risks of inconsistencies, in the root folder:

```
npm run site
yarn site
```

### Important
Since travis is failing on executing a11y tests due to out of date suid you need to execute `npm run pa11y` locally before sending any pr to verify we're following accessibility standars.

## License

BSD License © Liferay, Inc.
BSD License © Liferay, Inc.

0 comments on commit 2ccf4ac

Please sign in to comment.