Skip to content

Commit b606434

Browse files
author
Timothy A. Loginov
committed
readme text
1 parent 0ca2a4b commit b606434

File tree

1 file changed

+30
-37
lines changed

1 file changed

+30
-37
lines changed

‎README.md

Lines changed: 30 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Here's a basic sample that shows how to quickly create an Angular2 application w
4242
<!DOCTYPE html>
4343
<html>
4444
<head>
45-
<title>Angular QuickStart</title>
45+
<title>Angular Quick Start</title>
4646
<meta charset="UTF-8">
4747
<meta name="viewport" content="width=device-width, initial-scale=1">
4848

@@ -79,46 +79,43 @@ In [demos](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos)
7979
[SystemJS](https://github.com/systemjs/systemjs) loader is used for
8080
dynamic modules loading.
8181

82-
1) Despite the AnyChart-Angular2 integration is available with package managers,
83-
the license allows to modify and use it freely. This quick start guide
84-
clarifies the structure of integration project and explains how it works and
85-
can be used.
86-
87-
Since the integration is cloned from GitHub and Node Package Manager
88-
(`npm` command) is available in command line, the following command compiles
89-
source code to **dist/** directory:
90-
```sh
91-
npm run build
92-
```
82+
1) Despite the AnyChart-Angular2 integration is available with package managers, the license allows to modify and use it freely (though you [need AnyChart license to use the library](http://anychart.com/buy) itself in commercial projects). This quick start guide clarifies the structure of integration project and explains how it works and how it can be used.
83+
84+
If the integration is cloned from GitHub and Node Package Manager (`npm` command) is available in command line, the following command compiles source code to **dist/** directory:
85+
86+
```sh
87+
npm run build
88+
```
9389

9490
2) If needed, `package.json` of demo-application can be configured to declare custom run-commands
95-
and to add required dependencies excepting already included.
91+
and to add required dependencies.
9692

9793
3) Run `npm install` command to load all required npm modules.
9894

9995
4) Configure `systemjs.config.js` to declare the mapping of dependencies of
10096
application (see any [demo](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos)
101-
to realise the basic configuration). In 'map'-section this integration library is declared
97+
to see the basic configuration). In 'map'-section AnyChart integration library is declared:
98+
10299
```
103100
...
104101
'anychart-angular2': 'node_modules/anychart-angular2'
105102
```
106103

107-
5) Also in 'packages'-section anychart-angular2 library is declared as well:
104+
5) In 'packages'-section anychart-angular2 library is declared:
105+
108106
```
109107
'anychart-angular2': {
110108
main: 'index'
111109
}
112110
```
113111

114-
6) These actions allow to use anychart-angular2 integration in application
115-
like described in [Quick start](#quick-start).
112+
6) These actions allow to use anychart-angular2 integration in an application
113+
like one described in [Quick start](#quick-start).
116114

117115
7) Since 'app' folder is declared in `systemjs.config.js` as application root
118116
directory, the application's Angular2 modules and components can be created
119117
right there.
120118

121-
122119
## Package directory
123120

124121
```
@@ -146,8 +143,7 @@ Anychart typescript definition file. Used to correctly compile source
146143
code to **dist/** directory.
147144

148145
- **dist/** -
149-
Output directory that contains compiled `js` and `d.ts` files to provide
150-
availability to use this integration as library. The general component
146+
Output directory that contains compiled `js` and `d.ts` files. The general component
151147
declarations (**components.js** and **components.d.ts**) rely on this directory
152148
content.
153149

@@ -160,33 +156,30 @@ Components definition. Relies on **dist/** directory content.
160156

161157
- **package.json** -
162158
Package manager configuration file. Also contains descriptions of
163-
available run commands (including build command) and list of dependencies.
164-
159+
available run commands (including build command) and the list of dependencies.
165160

166161
## Demos overview
167162
See these samples to learn how things work:
168-
* **[Load_Data_From_Json](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Load_Data_From_Json)**: Demo of async data loading. Also
169-
shows how AnychartService can be used. **Please, note:** This demo can launched only from a web-server, in browser window, because of cross origin requests security issues.
170-
* **[Gantt_Project_After_Draw](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Gantt_Project_After_Draw)**: Shows how to create Gantt Project
163+
* **[Load Data From JSON](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Load_Data_From_Json)**: Async data loading sample. Also
164+
shows how AnychartService can be used. **Note:** this demo can be launched only from a web-server, in browser window, because of cross origin requests security issues.
165+
* **[Gantt Project After Draw](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Gantt_Project_After_Draw)**: Shows how to create a Gantt Project
171166
Chart and add the after-draw handler.
172-
* **[Gantt_Resource_Instance_Usage](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Gantt_Resource_Instance_Usage)**: Shows how to use manually created
167+
* **[Gantt Resource with Instance](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Gantt_Resource_Instance_Usage)**: Shows how to use manually created
173168
instance of a Gantt Resource chart and how to add the after-draw handler.
174-
* **[Line_Chart_After_Draw](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Line_Chart_After_Draw)**: Demonstrates how to create and use instance
169+
* **[Line Chart After Draw](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Line_Chart_After_Draw)**: Shows how to create and use instance
175170
of a chart and add the after-draw handler.
176-
* **[Line_Chart_Data_Streaming](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Line_Chart_Data_Streaming)**: Simple data-streaming demo.
177-
* **[Simple_Charts_On_Stage](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Simple_Charts_On_Stage)**: Demonstrates how to create and add simple
171+
* **[Line Chart Data Streaming](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Line_Chart_Data_Streaming)**: Simple data streaming demo.
172+
* **[Simple Charts On Stage](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Simple_Charts_On_Stage)**: Shows how to create and add simple
178173
charts on the anychart stage and how to add the after-draw handler.
179-
* **[Simple_Gantt_Project](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Simple_Gantt_Project)**: Simple Gantt Project Chart demo.
180-
* **[Simple_Map](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Simple_Map)**: Simple Anymap demo.
181-
* **[Simple_Pie](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Simple_Pie)**: Simple Pie chart demo.
174+
* **[Simple Gantt Project](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Simple_Gantt_Project)**: Simple Gantt Project Chart demo.
175+
* **[Simple Map](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Simple_Map)**: Simple AnyMap demo.
176+
* **[Simple Pie](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Simple_Pie)**: Simple Pie chart demo.
182177
* **[Simple_Stock_Area](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Simple_Stock_Area)**: Simple AnyStock demo.
183-
* **[Software_Sales_Dashboard](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Software_Sales_Dashboard)**: Demonstrates how to use `anychart-stage`
184-
directive to build the interactive dashboard.
178+
* **[Software_Sales_Dashboard](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Software_Sales_Dashboard)**: Shows how to use `anychart-stage`
179+
directive to build an interactive dashboard.
185180
* **[World_Map_Instance_After_Draw](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/World_Map_Instance_After_Draw)**: World map demo. Shows how to
186181
use map chart instance and how to add the after-draw handler.
187182

188-
189-
190183
## Contacts
191184

192185
* Web: [www.anychart.com](http://www.anychart.com)
@@ -201,7 +194,7 @@ charts on the anychart stage and how to add the after-draw handler.
201194
* [Download AnyChart](http://www.anychart.com/download/)
202195
* [AnyChart Licensing](http://www.anychart.com/buy/)
203196
* [AnyChart Support](http://www.anychart.com/support/)
204-
* [Report Issues](http://github.com/AnyChart/anychart/issues)
197+
* [Report Issues](https://github.com/AnyChart/AnyChart-AngularJS-2.x/issues)
205198
* [AnyChart Playground](http://playground.anychart.com)
206199
* [AnyChart Documentation](http://docs.anychart.com)
207200
* [AnyChart API Reference](http://api.anychart.com)

0 commit comments

Comments
 (0)