Skip to content

Commit 2823a8d

Browse files
committed
Version bump
1 parent ddb4f2a commit 2823a8d

File tree

3 files changed

+10
-19
lines changed

3 files changed

+10
-19
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ngx-simple-charts",
3-
"version": "0.0.3",
3+
"version": "0.0.4",
44
"license": "Apache License Version 2.0",
55
"scripts": {
66
"ng": "ng",
Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,15 @@
11
# NgxSimpleCharts
22

3-
This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 11.0.5.
3+
This is a small chart library for Angular based on D3js. It currently supports line charts. Its purpose is to enable fast updates to new Angular versions. To enable the fast updates and due to limited time the library will continue have a small feature set.
44

5-
## Code scaffolding
5+
## Line Charts
6+
To use the line chart component this module has to be imported: [NgxSimpleChartsModule](https://github.com/Angular2Guy/ngx-simple-charts/blob/master/projects/ngx-simple-charts/src/lib/ngx-simple-charts.module.ts)
67

7-
Run `ng generate component component-name --project ngx-simple-charts` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project ngx-simple-charts`.
8-
> Note: Don't forget to add `--project ngx-simple-charts` or else it will be added to the default project in your `angular.json` file.
8+
Then the component can be used: [<sc-line-chart [chartPoints]="..."></sc-line-chart>](https://github.com/Angular2Guy/ngx-simple-charts/blob/master/projects/ngx-simple-charts/src/lib/sc-line-chart/sc-line-chart.component.ts)
99

10-
## Build
10+
The interface for the chartPoints can be found here: [ChartPoints](https://github.com/Angular2Guy/ngx-simple-charts/blob/master/projects/ngx-simple-charts/src/lib/model/chart-points.ts)
1111

12-
Run `ng build ngx-simple-charts` to build the project. The build artifacts will be stored in the `dist/` directory.
12+
To enable some styling of the chart these classes can be used: [Component.scss](https://github.com/Angular2Guy/ngx-simple-charts/blob/master/projects/ngx-simple-charts/src/lib/sc-line-chart/sc-line-chart.component.scss)
1313

14-
## Publishing
15-
16-
After building your library with `ng build ngx-simple-charts`, go to the dist folder `cd dist/ngx-simple-charts` and run `npm publish`.
17-
18-
## Running unit tests
19-
20-
Run `ng test ngx-simple-charts` to execute the unit tests via [Karma](https://karma-runner.github.io).
21-
22-
## Further help
23-
24-
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
14+
## Some time in the future
15+
There might Bar Charts be added at some time in the future. For more features pull requests are welcome.

projects/ngx-simple-charts/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ngx-simple-charts",
3-
"version": "0.0.3",
3+
"version": "0.0.4",
44
"license" : "Apache License Version 2.0",
55
"peerDependencies": {
66
"@angular/common": "^11.1.0",

0 commit comments

Comments
 (0)