summaryrefslogtreecommitdiff
path: root/framework/Web/Javascripts/effects/README
blob: 94ff130721181e617690bf690ffa9503d79e74dd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
== script.aculo.us web 2.0 javascript

The Web is changing. The 30-year-old terminal-like technology it was originally 
is gradually giving way to new ways of doing things. The power of AJAX allows 
for rich user interaction without the trouble that has bugged traditional 
web applications. 

Building upon the wonderful Prototype JavaScript library, script.aculo.us 
provides you with some great additional ingredients to mix in.

For more information, see http://script.aculo.us/

== What's new in this release?

See the CHANGELOG file for information on what's new.

== Installation/Usage

script.aculo.us includes the Prototype JavaScript Framework 
V1.5.0. You can use later versions, as they become available 
(see http://prototype.conio.net).

Put prototype.js, and the six files scriptaculous.js, 
builder.js, effects.js, dragdrop.js, controls.js and slider.js 
in a directory of your website, e.g. /javascripts.

(The unittest.js file is optional and is only needed if you
want to do unit testing on your own javascripts).

Now, you can include the scripts by adding the following 
tags to the HEAD section of your HTML pages:

 <script src="/javascripts/prototype.js" type="text/javascript"></script>
 <script src="/javascripts/scriptaculous.js" type="text/javascript"></script>

scriptaculous.js will automatically load the other files of the 
script.aculo.us distribution in, provided they are accessible 
via the same path.

See http://wiki.script.aculo.us/scriptaculous/show/Usage for detailed
usage instructions.

== The distribution

Besides the script.aculo.us files in src, there's a complete
test tree included which holds functional and unit tests for
script.aculo.us.

If you need examples on how to implement things, the best place to
start is by opening test/run_functional_tests.html or 
test/run_unit_tests.html in your browser, and looking at
the sources of the examples provided.

== License

script.aculo.us is licensed under the terms of the MIT License, 
see the included MIT-LICENSE file.