Prototype JavaScript framework
Go to file
tjcrowder 63b7c5d9e8 doc: Added caveats and examples to String#stripTags and String#stripScripts [#102 state:resolved] 2009-08-22 04:36:24 +02:00
dist Reorganized unit tests to match the file structure of the source. 2008-12-11 12:06:00 +01:00
ext/update_helper deprecation extension: Modified deprecation notice for Array#reduce. 2009-03-23 23:35:13 +01:00
src doc: Added caveats and examples to String#stripTags and String#stripScripts [#102 state:resolved] 2009-08-22 04:36:24 +02:00
templates/html Clean-up namespace template. 2009-08-22 04:23:32 +02:00
test Update UnittestJS. Modifiy test template accordingly. 2009-08-12 01:25:59 +02:00
vendor Update to latest PDoc. 2009-08-22 03:29:15 +02:00
.gitignore Add `tmp` directory to ignores. 2009-03-09 11:23:25 -05:00
.gitmodules Add sprockets as a submodule 2009-01-27 13:32:57 -06:00
CHANGELOG Updated changelog. 2009-08-12 01:31:35 +02:00
LICENSE prototype: Update copyright date in LICENSE 2008-01-25 22:54:47 +00:00
README.rdoc Replace calls to String#gsub by String#replace internally, be more specific about which version of Safari is supported 2009-07-21 17:52:43 +02:00
Rakefile Fixed doc template to allow separate building of the documentation of each section. Usage: rake doc SECTION=lang. 2009-08-22 03:56:41 +02:00

README.rdoc

= Prototype
==== An object-oriented JavaScript framework

Prototype is a JavaScript framework that aims to ease development of dynamic 
web applications.  It offers a familiar class-style OO framework, extensive
Ajax support, higher-order programming constructs, and easy DOM manipulation.

=== Targeted platforms

Prototype currently targets the following platforms:

* Microsoft Internet Explorer for Windows, version 6.0 and higher
* Mozilla Firefox 1.5 and higher
* Apple Safari 2.0.4 and higher
* Opera 9.25 and higher
* Chrome 1.0 and higher

== Using Prototype

To use Prototype in your application, download the latest release from the 
Prototype web site (http://prototypejs.org/download) and copy 
<tt>dist/prototype.js</tt> to a suitable location. Then include it in your HTML
like so:

  <script type="text/javascript" src="/path/to/prototype.js"></script>

=== Building Prototype from source

<tt>prototype.js</tt> is a composite file generated from many source files in 
the <tt>src/</tt> directory. To build Prototype, you'll need:

* a copy of the Prototype source tree, either from a distribution tarball or
  from the Git repository (see below)
* Ruby 1.8.2 or higher (http://www.ruby-lang.org/)
* Rake -- Ruby Make (http://rake.rubyforge.org/)
* RDoc, if your Ruby distribution does not include it

From the root Prototype directory,

* <tt>rake dist</tt> will preprocess the Prototype source using ERB and 
  generate the composite <tt>dist/prototype.js</tt>.
* <tt>rake package</tt> will create a distribution tarball in the 
  <tt>pkg/</tt> directory.

== Contributing to Prototype

Check out the Prototype source with 
  $ git clone git://github.com/sstephenson/prototype.git
  $ cd prototype
  $ git submodule init
  $ git submodule update

Find out how to contribute:
  http://prototypejs.org/contribute

== Documentation

Please see the online Prototype API:
  http://prototypejs.org/api