Skip to content

Commit dc8e164

Browse files
committed
add motivation part to readme
1 parent dba7e2a commit dc8e164

File tree

4 files changed

+51
-20
lines changed

4 files changed

+51
-20
lines changed

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
<strong>English</strong> | <a href="https://github.com/syt123450/giojs/blob/master/README_zh.md"><strong>中文</strong></a>
88
</p>
99

10+
<p align="center">React Version: <a href="https://github.com/syt123450/react-giojs">react-giojs</a></p>
11+
1012
<p align="center">
1113
<a href="https://www.npmjs.com/package/giojs"><img src="https://img.shields.io/npm/v/giojs.svg" alt="npm version" height="18"></a>
1214
<a href="https://github.com/syt123450/Gio.js/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-green.svg" alt="license badge"></a>
@@ -15,9 +17,7 @@
1517
<a href="https://coveralls.io/github/syt123450/Gio.js?branch=master"><img src="https://coveralls.io/repos/github/syt123450/Gio.js/badge.svg" alt="coverage"></a>
1618
</p>
1719

18-
**Gio.js** is an open source library for data visualization library based on a 3D globe. This library is inspired by the [Arms Trade Visualization](http://armsglobe.chromeexperiments.com/) project developed by Michael Chang and presented during Google Ideas INFO 2012. See [original post](http://mflux.tumblr.com/post/28367579774/armstradeviz). What makes Gio.js different is that it is fully customizable for users, friendly to future developers to use in a declarative way.
19-
20-
There is a React version of giojs -- react-giojs, try it in another repo: https://github.com/syt123450/react-giojs
20+
**Gio.js** is an open source library for web 3D globe data visualization based on Three.js. What makes Gio.js different is that it is **simple** to use Gio.js to **customize** a 3D data visualization model in a declarative way and integrate it into your own **modern** web application.
2121

2222
<!-- [START screenshot] -->
2323
<p align="center">
@@ -27,10 +27,25 @@ There is a React version of giojs -- react-giojs, try it in another repo: https:
2727

2828
## Content
2929

30+
* [Motivation](#motivation)
3031
* [Getting Started](#getting-started)
3132
* [Examples](#examples)
3233
* [Documentation](#documentation)
3334

35+
<!-- [START motivation] -->
36+
37+
## Motivation
38+
39+
**Gio.js** is an open source library for web 3D globe data visualization based on Three.js. What makes Gio.js different is that it is **simple** to use Gio.js to **customize** a 3D data visualization model in a declarative way and integrate it into your own **modern** web application.
40+
41+
This library is inspired by the <a href="https://github.com/dataarts/armsglobe">Arms Trade Visualization project</a> developed by Michael Chang and presented during Google Ideas INFO 2012. See <a href="http://mflux.tumblr.com/post/28367579774/armstradeviz">original post</a>. With Gio.js, it is easy to reproduce this fantastic data visualization model, and integrate it into web application.
42+
43+
* **Simplicity** -- Create a 3D global data visualization model with your own data in just four lines of javascript code
44+
* **Customization** -- Design your own globe style with easy to use APIs in Gio.js
45+
* **Modernization** -- Build a responsible, fully interactive, rich 3D frontend application using Gio.js
46+
47+
<!-- [END motivation] -->
48+
3449
<!-- [START getstarted] -->
3550
## Getting Started
3651

@@ -48,7 +63,7 @@ Include local Gio.js library
4863
or through CDN
4964
```html
5065
<script src="https://threejs.org/build/three.min.js"></script>
51-
<script src="https://rawgit.com/syt123450/Gio.js/master/build/gio.min.js"></script>
66+
<script src="https://raw.githack.com/syt123450/giojs/master/build/gio.min.js"></script>
5267
```
5368
- Option 2: npm
5469
```bash
@@ -103,7 +118,7 @@ To initialize and render the 3D Gio globe:
103118
104119
</script>
105120
```
106-
If everything goes well, you should see [this](http://giojs.org/examples/00_hello_world(simplest).html).
121+
If everything goes well, you shall see [this](http://giojs.org/examples/00_hello_world(simplest).html). For more fancier usage of Gio.js, check out <a href="http://giojs.org/html/docs/index.html">Gio.js API document</a>
107122

108123
Click the codepen logo to try it in Codepen: &nbsp;&nbsp;<a target="_blank" href="https://codepen.io/syt123450/pen/VXNdgM"><img width=50 height=50 src="https://rawgit.com/syt123450/Gio.js/master/assets/readme/codepen.png"></a>
109124

@@ -117,7 +132,7 @@ Gio.js has many representative demos to show how to work with Gio.js, there are
117132

118133
- Resource 1: Gio.js Playground
119134

120-
There is a Playground(<a href="http://giojs.org/html/playground.html">playground link</a>) for developers to play with Gio.js and export Gio.js parameter.
135+
There is a Playground ( <a href="http://giojs.org/html/playground.html">playground link</a> ) for developers to play with Gio.js and export Gio.js parameter.
121136

122137
- Resource 2: Github "examples" folder
123138

README_zh.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
<a href="https://github.com/syt123450/giojs/blob/master/README.md"><strong>English</strong></a> | <strong>中文</strong>
88
</p>
99

10+
<p align="center">React版本: <a href="https://github.com/syt123450/react-giojs">react-giojs</a></p>
11+
12+
1013
<p align="center">
1114
<a href="https://www.npmjs.com/package/giojs"><img src="https://img.shields.io/npm/v/giojs.svg" alt="npm version" height="18"></a>
1215
<a href="https://github.com/syt123450/Gio.js/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-green.svg" alt="license badge"></a>
@@ -15,9 +18,7 @@
1518
<a href="https://coveralls.io/github/syt123450/Gio.js?branch=master"><img src="https://coveralls.io/repos/github/syt123450/Gio.js/badge.svg" alt="coverage"></a>
1619
</p>
1720

18-
**Gio.js** 是一个用来做3D地球数据可视化的开源组件库,这个库是受到Google 2012 Info大会上的项目[武器贩卖可视化](http://armsglobe.chromeexperiments.com/)启发,原项目开发者是Google员工Michael Chang。Gio.js的不同之处在于开发者可以以一种以声明的方式来使用,简洁地创建3D地球可视化模型,通过丰富的Gio.js API方便地定制模型并整合到自己的Web应用中。
19-
20-
Gio.js有一个React版本——react-giojs,有兴趣的话去这个仓库看看吧:https://github.com/syt123450/react-giojs
21+
**Gio.js** 是一个基于Three.js的web 3D地球数据可视化的开源组件库。使用Gio.js的网页应用开发者,可以快速地以申明的方式创建自定义的Web3D数据可视化模型,并且将其作为一个组件整合到自己的应用中。
2122

2223
<!-- [START screenshot] -->
2324
<p align="center">
@@ -27,10 +28,25 @@ Gio.js有一个React版本——react-giojs,有兴趣的话去这个仓库看
2728

2829
## 目录
2930

31+
* [为什么要使用Gio.js](#motivation)
3032
* [开始使用](#getting-started)
3133
* [例子](#examples)
3234
* [文档](#documentation)
3335

36+
<!-- [START motivation] -->
37+
38+
## <div id="motivation">为什么要使用Gio.js</div>
39+
40+
**Gio.js** 是一个基于Three.js的web 3D地球数据可视化的开源组件库。使用Gio.js的网页应用开发者,可以快速地以申明的方式创建自定义的Web3D数据可视化模型,并且将其作为一个组件整合到自己的应用中。
41+
42+
这个库的开发是受到Google 2012 Info大会上的项目[世界武器贩卖可视化](https://github.com/dataarts/armsglobe)的启发,该项目开发者是Google员工Michael Chang。使用Gio.js就可以快速构建这种炫酷的3D模型,并以此为基础进行深入地开发。
43+
44+
* **易用性** -- 仅使用4行Javascript即可创建3D地球数据可视化模型
45+
* **定制化** -- 使用Gio.js提供的丰富的API来创建自定义样式的3D地球
46+
* **现代化** -- 基于Gio.js构建高交互、自适应的现代化3D前端应用
47+
48+
<!-- [END motivation] -->
49+
3450
<!-- [START getstarted] -->
3551
## <div id="getting-started">开始使用</div>
3652

@@ -48,7 +64,7 @@ Gio.js有一个React版本——react-giojs,有兴趣的话去这个仓库看
4864
或者通过CDN引入依赖:
4965
```html
5066
<script src="https://threejs.org/build/three.min.js"></script>
51-
<script src="https://rawgit.com/syt123450/Gio.js/master/build/gio.min.js"></script>
67+
<script src="https://raw.githack.com/syt123450/giojs/master/build/gio.min.js"></script>
5268
```
5369
- 途径2: JavaScript包管理工具NPM
5470
```bash
@@ -103,7 +119,7 @@ yarn add giojs
103119
104120
</script>
105121
```
106-
如果一切顺利,在浏览器中打开您的HTML页面你将会看到以下3D地球: [用力点我](http://giojs.org/examples/00_hello_world(simplest).html).
122+
如果一切顺利,在浏览器中打开您的HTML页面你将会看到以下3D地球: [用力点我](http://giojs.org/examples/00_hello_world(simplest).html). 如果有兴趣了解更多Gio.js有趣的用法,我们强烈推荐Gio.js的<a href="http://giojs.org/html/docs/index.html">文档</a>
107123

108124
点击后面这个Codepen logo来在Codepen中试一下这个例子吧 ~ &nbsp;&nbsp;<a target="_blank" href="https://codepen.io/syt123450/pen/VXNdgM"><img width=50 height=50 src="https://rawgit.com/syt123450/Gio.js/master/assets/readme/codepen.png"></a>
109125

@@ -127,11 +143,11 @@ Gio.js有很多codepen的例子,你可以在codepen中编辑修改它们。点
127143

128144
## <div id="documentation">文档</div>
129145

130-
- 如果想要快速了解如何使用Giojs的话,看看 [开始使用](https://github.com/syt123450/giojs/blob/master/docs/zh/Getting_Started_zh.md) ~
131-
- 如果想要了解Giojs的基本组件,看看 [基础组件](https://github.com/syt123450/giojs/blob/master/docs/zh/Basic_Elements_zh.md) ~
132-
- 如果你有丰富的第三方组件的使用经验,不妨直接研究一下 [Giojs API 文档](https://github.com/syt123450/giojs/blob/master/docs/zh/APIs_zh.md)~
133-
- 如果想要加入我们Giojs的开发,来看看 [开发者文档](https://github.com/syt123450/giojs/blob/master/docs/zh/Developer_Guide_zh.md) ~
134-
- 当然如果看不惯Markdown格式的文档,我们也准备了中文版的网站 [官网](http://giojs.org/index_zh.html)
146+
- 如果想要快速了解如何使用Giojs的话, [开始使用](https://github.com/syt123450/giojs/blob/master/docs/zh/Getting_Started_zh.md) 是一个好的开始
147+
- 如果想要了解Giojs的基本组件, [基础组件](https://github.com/syt123450/giojs/blob/master/docs/zh/Basic_Elements_zh.md) 会帮助你缕清Gio.js中的基本概念
148+
- 如果你有丰富的第三方组件的使用经验, [Giojs API 文档](https://github.com/syt123450/giojs/blob/master/docs/zh/APIs_zh.md)
149+
- 如果想要加入我们Giojs的开发,不妨先了解一下 [开发者文档](https://github.com/syt123450/giojs/blob/master/docs/zh/Developer_Guide_zh.md) 可以帮助你快速上手开发
150+
- 在我们的Gio.js中文版官网中,有对Gio.js最为详细的介绍 [官网](http://giojs.org/index_zh.html)
135151

136152
[screenshot-url]: http://via.placeholder.com/400x300
137153
[npm-badge]: https://img.shields.io/badge/npm-v0.0.5-orange.svg

docs/en/Getting_Started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Gio.js Hello World
22

3-
**Gio.js** is an open source library for data visualization on a 3D globe. This library is inspired by the [Arms Trade Visualization](http://armsglobe.chromeexperiments.com/) project developed by Michael Chang and presented during Google Ideas INFO 2012. What makes Gio.js different is that it is fully customizable for user and friendly to future developers.
3+
**Gio.js** is an open source library for data visualization on a 3D globe. This library is inspired by the [Arms Trade Visualization](https://github.com/dataarts/armsglobe) project developed by Michael Chang and presented during Google Ideas INFO 2012. What makes Gio.js different is that it is fully customizable for user and friendly to future developers.
44

55
<!-- [START screenshot] -->
66
<p>
@@ -24,7 +24,7 @@ Include local Gio.js library
2424
```
2525
or through CDN
2626
```html
27-
<script src="https://cdn.rawgit.com/syt123450/giojs/de5fd34a/build/gio.min.js"></script>
27+
<script src="https://raw.githack.com/syt123450/giojs/master/build/gio.min.js"></script>
2828
```
2929
- Option 2: npm
3030
```bash

docs/zh/Getting_Started_zh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 开始使用Gio.js
22

3-
**Gio.js** 是一个用来做3D地球数据可视化的开源组件库,这个库是受到Google 2012 Info大会上的项目[武器贩卖可视化](http://armsglobe.chromeexperiments.com/)启发,原开发者是Michael Chang。Gio.js的不同之处在于开发者可以以一种以声明的方式来使用,简洁地创建3D地球可视化模型,通过丰富的Gio.js API方便地定制模型并整合到自己的Web应用中。
3+
**Gio.js** 是一个用来做3D地球数据可视化的开源组件库,这个库是受到Google 2012 Info大会上的项目[武器贩卖可视化](https://github.com/dataarts/armsglobe)启发,原开发者是Michael Chang。Gio.js的不同之处在于开发者可以以一种以声明的方式来使用,简洁地创建3D地球可视化模型,通过丰富的Gio.js API方便地定制模型并整合到自己的Web应用中。
44

55
<!-- [START screenshot] -->
66
<p>
@@ -26,7 +26,7 @@
2626
或者通过CDN引入依赖:
2727
```html
2828
<script src="https://threejs.org/build/three.min.js"></script>
29-
<script src="https://cdn.rawgit.com/syt123450/giojs/de5fd34a/build/gio.min.js"></script>
29+
<script src="https://raw.githack.com/syt123450/giojs/master/build/gio.min.js"></script>
3030
```
3131

3232
- 途径2: JavaScript包管理工具NPM

0 commit comments

Comments
 (0)