binbot-charts 0.12.18 → 0.12.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -55,8 +55,16 @@ console.log(binanceConfig.restApiUrl); // "https://api.binance.com"
|
|
|
55
55
|
## How to start
|
|
56
56
|
|
|
57
57
|
1. Run `npm install && npm start`. It will build the project and open a default browser with the Charting Library.
|
|
58
|
-
2. `
|
|
59
|
-
|
|
58
|
+
2. Run `npm run build` if it's the first time building the library. The example src project will use the final build.
|
|
59
|
+
> `library_path` should be `node_modules/dist/charting_library`
|
|
60
|
+
> Write a script to copy `charting_library` to `public/charting_library` during build. E.g. `cp -r node_modules/dist/charting_library/ src/public/charting_library`
|
|
61
|
+
3. Run `npm run format` and `npm run test` before pushing to the PR to avoid failed Github checks
|
|
62
|
+
4. To publish:
|
|
63
|
+
- Make your changes and do the usual `git commit` but do not `git push`
|
|
64
|
+
- you need to run `npm run release-patch`. This follows semver, so you have a few other options, see package.json for more.
|
|
65
|
+
- The release command will push your commit changes
|
|
66
|
+
- If you don't do it this way, it'll fail the release process
|
|
67
|
+
|
|
60
68
|
|
|
61
69
|
## About This Project
|
|
62
70
|
|
package/package.json
CHANGED