Skip to content

Commit 51e9ee7

Browse files
committed
README: expand description, add links to live samples
1 parent f4e3018 commit 51e9ee7

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
## GTween for Haxe
22

3-
GTween is a small but extremely robust Haxe library for programmatic tweening, animation, and transitions, based on the AS3 library for Adobe Flash built by Grant Skinner of [gskinner.com](http://www.gskinner.com/). It is currently comprised of 3 key classes:
3+
GTween is a small but extremely robust [Haxe](https://haxe.org/) library for programmatic tweening, animation, and transitions. It is based on the AS3 library for Adobe Flash built by Grant Skinner of _gskinner.com_.
4+
5+
The GTween library is currently comprised of 3 key classes:
46

57
* **GTween**. A robust tweening engine, packed full of innovative features.
68
* **GTweenTimeline**. A powerful virtual timeline that extends GTween to enable you to sequence tweens and actions.
79
* **GTweener**. A static interface to GTween.
810

9-
It also comes with a variety of plug-ins and easing classes.
11+
GTween also comes with a variety of plug-ins and easing classes to customize your animations.
12+
13+
The Haxe version of GTween is designed to be added to _any_ Haxe project, not just those that depend on libraries like OpenFL that provide an Adobe Flash-inspired API. A subset of GTween's plugins are restricted to OpenFL features only, but the core library is written in pure Haxe and can absolutely be used without OpenFL as a dependency.
1014

1115
GTween is licensed under the **MIT license**, so it can be used and modified with **almost no restrictions in commercial projects** beyond maintaining the header in the source files.
1216

@@ -57,6 +61,8 @@ myTween.proxy.x += 100;
5761

5862
### Sequencing
5963

64+
([timeline demo](https://bowlerhatllc.github.io/gtween-haxe/samples/openfl/GTweenTimelineDemo/)
65+
6066
GTweenTimeline lets you set up complex animations or transitions on a **virtual timeline**.
6167
In addition to tweens, you can add actions and labels at specified positions.
6268
Pause, reverse, and jump to the start or end of the full timeline as easily as you would with a single tween.
@@ -88,6 +94,8 @@ GTween supports both frame and time based tweens on a per tween basis. You can s
8894

8995
### Extensibility
9096

97+
([color adjust plugin demo](https://bowlerhatllc.github.io/gtween-haxe/samples/openfl/GTweenColorAdjust/)
98+
9199
The code base for GTween is straightforward and easy to read, extend, and modify. It also supports an easy to use, robust plug-in model which makes it easy to add and share custom functionality without having to modify or extend the core classes.
92100

93101
### Etcetera
@@ -107,7 +115,23 @@ The best place to learn about these and other features is by checking out the in
107115

108116
## Demos
109117

110-
All source code for these demos is included with the download.
118+
All source code for these demos is included in the Git repository.
119+
120+
The following demos are available for [OpenFL](https://openfl.org/), a library that implements the Adobe Flash Player API in Haxe:
121+
122+
* [Advanced Sequencing Demo](https://bowlerhatllc.github.io/gtween-haxe/samples/openfl/GTweenTimelineDemo/)
123+
* [Tween Interrupt Demo](https://bowlerhatllc.github.io/gtween-haxe/samples/openfl/GTweenInterrupt/)
124+
* [Color Adjust Plugin Demo](https://bowlerhatllc.github.io/gtween-haxe/samples/openfl/GTweenColorAdjust/)
125+
* [Motion Blur and Simple Sequencing Demo](https://bowlerhatllc.github.io/gtween-haxe/samples/openfl/GTweenSimpleSequencing/)
126+
* [GTween Speed Demo](https://bowlerhatllc.github.io/gtween-haxe/samples/openfl/GTweenSpeedDemo/)
127+
* [GTweener Demo](https://bowlerhatllc.github.io/gtween-haxe/samples/openfl/GTweenerDemo/)
128+
129+
The next demos compile pure Haxe to JavaScript (JS) and manipulate [HTML DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model/Introduction) nodes:
130+
131+
* [Tween Interrupt Demo](https://bowlerhatllc.github.io/gtween-haxe/samples/js/GTweenInterrupt/)
132+
* [Motion Blur and Simple Sequencing Demo](https://bowlerhatllc.github.io/gtween-haxe/samples/js/GTweenSimpleSequencing/)
133+
* [GTween Speed Demo](https://bowlerhatllc.github.io/gtween-haxe/samples/js/GTweenSpeedDemo/)
134+
* [GTweener Demo](https://bowlerhatllc.github.io/gtween-haxe/samples/js/GTweenerDemo/)
111135

112136
## Documentation
113137

0 commit comments

Comments
 (0)