Skip to content

Commit bfda156

Browse files
nymphlynymphly
committed
Merged with develop
2 parents 2e00cb1 + b12387e commit bfda156

File tree

1 file changed

+33
-43
lines changed

1 file changed

+33
-43
lines changed

‎README.md

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

@@ -85,49 +85,43 @@ Here's a basic sample that shows how to quickly create an Angular2 application w
8585

8686
## Build
8787

88-
1) In [demos](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos) the
89-
[SystemJS](https://github.com/systemjs/systemjs) loader is used for
90-
dynamic modules loading.
91-
Despite the AnyChart-Angular2 integration is available with package managers,
92-
the license allows to modify and use it freely. This quick start guide
93-
clarifies the structure of integration project and explains how it works and
94-
can be used.
88+
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.
89+
90+
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:
91+
92+
```sh
93+
npm run build
94+
```
9595

96-
2) If needed, `package.json` of [demo](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos)-application
97-
can be configured to declare custom run-commands and to add required
98-
dependencies excepting already included.
96+
2) If needed, `package.json` of demo-application can be configured to declare custom run-commands
97+
and to add required dependencies excepting already included.
9998

10099
3) Run `npm install` command to load all required npm modules.
101100

102101
4) Configure `systemjs.config.js` to declare the mapping of dependencies of
103102
application (see any [demo](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos)
104-
to realise the basic configuration). In 'map'-section this integration library is declared
103+
to see the basic configuration). In 'map'-section AnyChart integration library is declared:
104+
105105
```
106106
...
107107
'anychart-angular2': 'node_modules/anychart-angular2'
108108
```
109109

110-
5) Also in 'packages'-section anychart-angular2 library is declared as well:
110+
5) In 'packages'-section anychart-angular2 library is declared:
111+
111112
```
112113
'anychart-angular2': {
113114
main: 'index'
114115
}
115116
```
116117

117-
6) These actions allow to use anychart-angular2 integration in application
118-
like described in [Quick start](#quick-start).
118+
6) These actions allow to use anychart-angular2 integration in an application
119+
like one described in [Quick start](#quick-start).
119120

120121
7) Since 'app' folder is declared in `systemjs.config.js` as application root
121122
directory, the application's Angular2 modules and components can be created
122123
right there.
123124

124-
8) Since the integration is cloned from GitHub and Node Package Manager
125-
(`npm` command) is available in command line, the following command compiles
126-
source code to **dist/** directory:
127-
```sh
128-
npm run build
129-
```
130-
131125

132126
## Package directory
133127

@@ -156,8 +150,7 @@ Anychart typescript definition file. Used to correctly compile source
156150
code to **dist/** directory.
157151

158152
- **dist/** -
159-
Output directory that contains compiled `js` and `d.ts` files to provide
160-
availability to use this integration as library. The general component
153+
Output directory that contains compiled `js` and `d.ts` files. The general component
161154
declarations (**components.js** and **components.d.ts**) rely on this directory
162155
content.
163156

@@ -170,33 +163,30 @@ Components definition. Relies on **dist/** directory content.
170163

171164
- **package.json** -
172165
Package manager configuration file. Also contains descriptions of
173-
available run commands (including build command) and list of dependencies.
174-
166+
available run commands (including build command) and the list of dependencies.
175167

176168
## Demos overview
177169
See these samples to learn how things work:
178-
* **[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
179-
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.
180-
* **[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
170+
* **[Load Data From JSON](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Load_Data_From_Json)**: Async data loading sample. Also
171+
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.
172+
* **[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
181173
Chart and add the after-draw handler.
182-
* **[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
174+
* **[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
183175
instance of a Gantt Resource chart and how to add the after-draw handler.
184-
* **[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
176+
* **[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
185177
of a chart and add the after-draw handler.
186-
* **[Line_Chart_Data_Streaming](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Line_Chart_Data_Streaming)**: Simple data-streaming demo.
187-
* **[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
178+
* **[Line Chart Data Streaming](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Line_Chart_Data_Streaming)**: Simple data streaming demo.
179+
* **[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
188180
charts on the anychart stage and how to add the after-draw handler.
189-
* **[Simple_Gantt_Project](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Simple_Gantt_Project)**: Simple Gantt Project Chart demo.
190-
* **[Simple_Map](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Simple_Map)**: Simple Anymap demo.
191-
* **[Simple_Pie](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Simple_Pie)**: Simple Pie chart demo.
192-
* **[Simple_Stock_Area](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Simple_Stock_Area)**: Simple AnyStock demo.
193-
* **[Software_Sales_Dashboard](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Software_Sales_Dashboard)**: Demonstrates how to use `anychart-stage`
194-
directive to build the interactive dashboard.
195-
* **[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
181+
* **[Simple Gantt Project](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Simple_Gantt_Project)**: Simple Gantt Project Chart demo.
182+
* **[Simple Map](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Simple_Map)**: Simple AnyMap demo.
183+
* **[Simple Pie](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Simple_Pie)**: Simple Pie chart demo.
184+
* **[Simple Stock Area](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Simple_Stock_Area)**: Simple AnyStock demo.
185+
* **[Software Sales Dashboard](https://github.com/AnyChart/AnyChart-AngularJS-2.x/tree/master/demos/Software_Sales_Dashboard)**: Shows how to use `anychart-stage`
186+
directive to build an interactive dashboard.
187+
* **[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
196188
use map chart instance and how to add the after-draw handler.
197189

198-
199-
200190
## Contacts
201191

202192
* Web: [www.anychart.com](http://www.anychart.com)
@@ -211,7 +201,7 @@ charts on the anychart stage and how to add the after-draw handler.
211201
* [Download AnyChart](http://www.anychart.com/download/)
212202
* [AnyChart Licensing](http://www.anychart.com/buy/)
213203
* [AnyChart Support](http://www.anychart.com/support/)
214-
* [Report Issues](http://github.com/AnyChart/anychart/issues)
204+
* [Report Issues](https://github.com/AnyChart/AnyChart-AngularJS-2.x/issues)
215205
* [AnyChart Playground](http://playground.anychart.com)
216206
* [AnyChart Documentation](http://docs.anychart.com)
217207
* [AnyChart API Reference](http://api.anychart.com)

0 commit comments

Comments
 (0)