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

Commit 54213a1

Browse files
mrkevfacebook-github-bot
authored andcommitted
Update readme to suggest building with yarn (#2527)
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
1 parent 5e92a32 commit 54213a1

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,6 @@ If you are interested in helping out, or tracking the progress, please follow
4747

4848
## Getting Started
4949

50-
Currently Draft.js is distributed via npm. It depends on React and React DOM which must also be installed.
51-
5250
```
5351
npm install --save draft-js react react-dom
5452
@@ -57,6 +55,8 @@ or
5755
yarn add draft-js react react-dom
5856
```
5957

58+
Draft.js depends on React and React DOM which must also be installed.
59+
6060
### Using Draft.js
6161

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

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

166168
```
167169
git clone https://github.com/facebook/draft-js.git
168170
cd draft-js
169-
npm install
170-
npm run build
171+
yarn install
172+
yarn run build
171173
```
172174

173175
then open the example HTML files in your browser.

0 commit comments

Comments
 (0)