diff --git a/README.md b/README.md index a566d4f..b654dfe 100644 --- a/README.md +++ b/README.md @@ -45,13 +45,13 @@ For use in your repo, install this library with the following command (you can alternatively use `yarn`, of course) ```bash -npm install @oceanprotocol/react +yarn add @oceanprotocol/react ``` If you want to clone this repo and work locally, then execute the following **instead** (in the root directory of this repository) ```bash -yarn install +yarn ``` ## 🏄 Quick Start @@ -132,7 +132,7 @@ The project uses TypeScript and compiled with the `tsc` command. To start the compiler in watch mode: ```bash -npm start +yarn run start ``` ## ✨ Code Style @@ -141,10 +141,10 @@ For linting and auto-formatting run these from the root of the repo: ```bash # auto format all ts & css with eslint & stylelint -npm run lint +yarn run lint # auto format all ts & css with prettier, taking all configs into account -npm run format +yarn run format ``` ## 👩🔬 Testing @@ -158,7 +158,7 @@ The build script will compile `src/` with [`microbundle`](https://github.com/dev 3. UMD build ```bash -npm run build +yarn build ``` ## ⬆️ Releases @@ -169,9 +169,9 @@ Releases are managed semi-automatically. They are always manually triggered from From a clean `main` branch you can run any release task bumping the version accordingly based on semantic versioning: -- To bump a patch version: `npm run release` -- To bump a minor version: `npm run release -- minor` -- To bump a major version: `npm run release -- major` +- To bump a patch version: `yarn run release` +- To bump a minor version: `yarn run release -- minor` +- To bump a major version: `yarn run release -- major` Every task does the following: @@ -191,13 +191,13 @@ Usually from a feature branch you can release a develop version under the `next` Say the current version is at `v1.1.0`, then to publish a pre-release for a next major version `v2.0.0-beta.0`, do: ```bash -npm run release -- major --preRelease=beta --npm.tag=next +yarn run release -- major --preRelease=beta --npm.tag=next # consecutive releases, e.g. to then get `v2.0.0-beta.1` -npm run release -- --preRelease +yarn run release -- --preRelease # final version, e.g. to then get `v2.0.0` -npm run release -- major +yarn run release -- major ``` ## 📜 Changelog diff --git a/example/config-overrides.js b/example/config-overrides.js index 5140ba8..26d1781 100644 --- a/example/config-overrides.js +++ b/example/config-overrides.js @@ -1,5 +1,5 @@ module.exports = function override(config, env) { - const path = require('path') + const path = require('path'); return { ...config, @@ -10,5 +10,5 @@ module.exports = function override(config, env) { react: path.resolve('../node_modules/react') } } - } -} + }; +}; diff --git a/example/package.json b/example/package.json index 127054f..44e43b6 100644 --- a/example/package.json +++ b/example/package.json @@ -8,7 +8,6 @@ "eject": "react-app-rewired eject" }, "dependencies": { - "@oceanprotocol/react": "file:../", "react": "^16.13.1", "react-dom": "^16.13.1", "react-scripts": "3.4.3", diff --git a/example/public/index.html b/example/public/index.html index 6bd9b20..0e50abf 100644 --- a/example/public/index.html +++ b/example/public/index.html @@ -17,7 +17,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`. -->