Skip to content
This repository has been archived by the owner on Feb 6, 2023. It is now read-only.

Commit

Permalink
Update readme to suggest building with yarn (#2527)
Browse files Browse the repository at this point in the history
Summary:
Every now and then there will be issues by people who try to build with NPM. The build works with yarn.

Pull Request resolved: #2527

Reviewed By: creedarky

Differential Revision: D22784874

Pulled By: mrkev

fbshipit-source-id: c38bd43d57de511df237745f74b1b9d4bb7bebd6
  • Loading branch information
mrkev authored and facebook-github-bot committed Aug 3, 2020
1 parent 5e92a32 commit 54213a1
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@ If you are interested in helping out, or tracking the progress, please follow

## Getting Started

Currently Draft.js is distributed via npm. It depends on React and React DOM which must also be installed.

```
npm install --save draft-js react react-dom
Expand All @@ -57,6 +55,8 @@ or
yarn add draft-js react react-dom
```

Draft.js depends on React and React DOM which must also be installed.

### Using Draft.js

```javascript
Expand Down Expand Up @@ -161,13 +161,15 @@ Visit http://draftjs.org/ to try out a basic rich editor example.
The repository includes a variety of different editor examples to demonstrate
some of the features offered by the framework.

To run the examples, first build Draft.js locally:
To run the examples, first build Draft.js locally. The Draft.js build is tested
with Yarn v1 only. If you're using any other package manager and something doesn't
work, try using yarn v1:

```
git clone https://github.com/facebook/draft-js.git
cd draft-js
npm install
npm run build
yarn install
yarn run build
```

then open the example HTML files in your browser.
Expand Down

0 comments on commit 54213a1

Please sign in to comment.