Skip to content

Commit 15b45da

Browse files
author
Jascha A. Quintern
committed
Update README.
1 parent 2e987d2 commit 15b45da

File tree

2 files changed

+9
-12
lines changed

2 files changed

+9
-12
lines changed

README.md

+8-11
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55

66
This library provides an OpenUI5 API that acts as a wrapper for D3-based charting library [C3.js](http://c3js.org/). It offers a more detailed and attractive API design than `sap.viz` chart controls, which interacts harmoniously especially in XML Views in combination with data binding.
77

8-
> Furthermore, this project is also a Boilerplate for all UI5 control libraries that rely completely on Open Source and uses 100% internally the same Gulp based build script as our [OpenUI5 Starter Kit](https://github.com/pulseshift/openui5-gulp-starter-kit). One build script to **rule them all**, I mean, how cool is that? Probably pretty cool, at least as long as we haven't found an alternative with Webpack yet. So take a look at our Starter Kit to learn more about the features and functionality of the build process.
9-
108
## Usage
119

1210
There are two options how to use the chart library in your UI5 project, depending of the project boilerplate you are using.
@@ -80,14 +78,14 @@ A brief overview of features, additional to C3.js line and area charts:
8078

8179
* Complete API coverage of properties and aggregations for a fully integrated feature set in XML views.
8280
* If supported by C3.js, rerender will be avoided by the chart control to ensure smooth transitions in case of changes in the data.
83-
* Support of pins and areas.
81+
* Support of chart annotations, like lines and areas in various designs.
8482
* Support for special designs such as animated dashed lines or hatched areas.
8583
* Convergence interval as a new display type of series.
8684
* Simple color management by implementing color palettes or individual colors for specific series.
8785

8886
### Example
8987

90-
To execute the demo, please follow the instructions described in section `Development`. At the time the demo is being refactored with the goal to provide you an SAP explored like experience.
88+
To execute the demo, please follow the instructions described in section `Development`. At the time the demo is being refactored with the goal to provide you an _SAP Explore_ like experience.
9189

9290
Here a basic sample of how to use the charts in an XML view:
9391

@@ -194,24 +192,23 @@ Info: To get a more detailed logging, use `yarn start:verbose` instead.
194192

195193
## Distribution
196194

197-
Start build:
195+
Start distribution build:
198196
_Will create a `dist` directory in your project root._
199197

200198
```
201-
yarn build
199+
yarn dist
202200
```
203201

204-
Afterwards, the production app build can be tested by run `yarn start:dist`. The app should open in your browser automatically, otherwise open: `http://localhost:3000/demo/index.html`
205-
206-
Info: To get a more detailed logging, use `yarn build:verbose` instead.
202+
This will build the app, test the code with linters and updates all docs automatically. Afterwards, the production app build can be tested by run `yarn start:dist`. The app should open in your browser automatically, otherwise open: `http://localhost:3000/demo/index.html`
207203

208-
Publish new version (please use correct [semantic versioning](https://docs.npmjs.com/getting-started/semantic-versioning)):
209-
_Will execute tests, update docs and create a `dist` directory in your project root as prepublish step._
204+
If the app build matches your requirements, upload your build to **npm**:
210205

211206
```
212207
yarn publish
213208
```
214209

210+
_When asket for bumping the version, please use correct [semantic versioning](https://docs.npmjs.com/getting-started/semantic-versioning)._
211+
215212
### Contributing & Troubleshooting
216213

217214
Contributions, questions and comments are all welcome and encouraged.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"build": "cross-env NODE_ENV=production babel-node node_modules/gulp/bin/gulp.js build",
1010
"build:disclaimer": "yarn licenses generate-disclaimer --production >> DISCLAIMER.md",
1111
"docs": "babel-node docs/tools/create-ui5-docs.js",
12-
"distPreparation": "yarn test && yarn docs && yarn build && yarn build:disclaimer"
12+
"dist": "yarn test && yarn docs && yarn build && yarn build:disclaimer"
1313
},
1414
"description": "UI5 Visualization Library",
1515
"repository": "https://github.com/pulseshift/ui5-lib-visualization.git",

0 commit comments

Comments
 (0)