From 54213a13ec46b956f9de8e975af5ba78dda0acab Mon Sep 17 00:00:00 2001 From: Kevin Chavez Date: Mon, 3 Aug 2020 13:03:19 -0700 Subject: [PATCH] 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: https://github.com/facebook/draft-js/pull/2527 Reviewed By: creedarky Differential Revision: D22784874 Pulled By: mrkev fbshipit-source-id: c38bd43d57de511df237745f74b1b9d4bb7bebd6 --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f120338322..6d11981b36 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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.