@pioneer-code/pioneer-charts 22.2.14 → 22.2.15

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License
2
+
3
+ Copyright (c) 2018 Chad Ramos & Pioneer Code.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
package/README.md CHANGED
@@ -10,7 +10,7 @@ Pioneer Charts is an Angular library for building beautiful, customizable, and r
10
10
 
11
11
  Guides, the API reference, live examples, and theming instructions all live on the docs site:
12
12
 
13
- **https://charts.pioneercode.com**
13
+ **https://pioneercharts.com**
14
14
 
15
15
  ## Features
16
16
 
@@ -36,7 +36,7 @@ The D3 modules the charts use are installed with the package, so there's nothing
36
36
  npm install --save @pioneer-code/pioneer-charts
37
37
  ```
38
38
 
39
- Then follow the [Introduction](https://charts.pioneercode.com) on the docs site to import the components and theme into your app.
39
+ Then follow the [Introduction](https://pioneercharts.com) on the docs site to import the components and theme into your app.
40
40
 
41
41
  ## Contributing
42
42
 
@@ -46,12 +46,16 @@ This repository is an Angular workspace containing the library (`projects/pionee
46
46
 
47
47
  ```bash
48
48
  npm ci
49
- npm start # serve the docs site, which consumes the library
49
+ npm run build:lib # build the library into dist/pioneer-charts - the docs site uses that build
50
+ npm start # serve the docs site
50
51
  npm run lint
51
- npm test # library unit tests (vitest)
52
- npm run build:lib # build the publishable package into dist/pioneer-charts
52
+ npm test # unit tests for the library and the docs site (vitest)
53
53
  ```
54
54
 
55
+ The docs site imports the library from `dist/pioneer-charts`, not its source, so it needs `build:lib`
56
+ before its first `npm start`. While working on both, run `npm run start-components` alongside
57
+ `npm start` to rebuild the library on every change.
58
+
55
59
  Every push and pull request to `main` is verified by [GitHub Actions](https://github.com/PioneerCode/pioneer-charts/actions) (lint, tests, and both builds).
56
60
 
57
61
  ### Releasing