Merge pull request #1371 from RodriSanchez1/doc/updateReadme

Remove npm CLI commands from README.md
cboard-org · Feb 19, 2023 · dcb491b · dcb491b
2 parents 5cfd424 + 46a0476
commit dcb491b
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -34,22 +34,22 @@ In order to pull the latest translations from CrowdIn into the codebase, you can
 
 ## Getting Started
 
-### `npm start` or `yarn start`
+### `yarn start`
 
 Runs the app in development mode.<br>
 Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 
 The page will reload if you make edits.<br>
 You will see the build errors and lint warnings in the console.
 
-### `npm test` or `yarn test`
+### `yarn test`
 
 Runs the test watcher in an interactive mode.<br>
 By default, runs tests related to files changed since the last commit.
 
 [Read more about testing.](https:/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#running-tests)
 
-### `npm run build` or `yarn build`
+### `yarn build`
 
 Builds the app for production to the `build` folder.<br>
 It correctly bundles React in production mode and optimizes the build for the best performance.
@@ -59,7 +59,7 @@ By default, it also [includes a service worker](https:/facebookincub
 
 Cboard is ready to be deployed.
 
-### `npm run build-cordova-debug`
+### `yarn build-cordova-debug`
 
 Use this to produce non-minified build for use in debugging within Cordova. It uses `react-app-rewired` & `config-overrides.js` to customize webpack operation without ejecting react.
 

diff --git a/package.json b/package.json
@@ -136,7 +136,7 @@
  "start": "react-scripts start",
  "build": "react-scripts build && sw-precache --config=sw-precache-config.js",
  "build-cordova-debug": "react-app-rewired build",
- "predeploy": "npm run build",
+ "predeploy": "yarn build",
  "deploy": "gh-pages -d build",
  "test": "react-scripts test",
  "decrypt:local": "./scripts/decrypt-private.sh local",

diff --git a/public/index.html b/public/index.html
@@ -13,7 +13,7 @@
  http://localhost:10010/
  http://www.googletagmanager.com/gtag/js
  wss://*.microsoft.com/cognitiveservices/
- blob: 
+ blob:
  gap:
  data:;
  img-src * data: filesystem: blob: ;
@@ -32,7 +32,7 @@
 
  Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
  work correctly both with client-side routing and a non-root public URL.
- Learn how to configure a non-root public URL by running `npm run build`.
+ Learn how to configure a non-root public URL by running `yarn build`.
  -->
 
  <!-- Add to homescreen for Chrome on Android -->
@@ -80,9 +80,9 @@
  You can add webfonts, meta tags, or analytics to this file.
  The build step will place the bundled scripts into the <body> tag.
 
- To begin the development, run `npm start` or `yarn start`.
- To create a production bundle, use `npm run build` or `yarn build`.
+ To begin the development, run `yarn start` or `yarn start`.
+ To create a production bundle, use `yarn run build` or `yarn build`.
  -->
 </body>
 
-</html>
+</html>