Skip to content

Commit

Permalink
Add information on UI controls.
Browse files Browse the repository at this point in the history
  • Loading branch information
savetheclocktower committed Sep 26, 2010
1 parent fcc8387 commit 431ec45
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.rdoc
Expand Up @@ -4,6 +4,7 @@ scripty2 is an open source JavaScript framework for advanced HTML-based user int

* Visual effects: scripty2's heartpiece is an versatile real-time effects framework
* CSS utilities
* UI components (experimental)

And there's more coming! scripty2 is currently in alpha status, so APIs can change and
there's still a lot more functionality planned.
Expand Down Expand Up @@ -39,6 +40,14 @@ At the moment this is a prerelease alpha version and not meant for
production use (although it is used with great success on several high
volume websites).

== Build with UI

The scripty2 UI controls are under heavy development and are still in alpha. They're not included when you run the standard rake tasks. To build a distributable with UI controls included, run:

rake dist:experimental

There are several other `*:experimental` tasks corresponding to common actions. Run `rake -T` to see the list of tasks.

= Usage

scripty2 is dependent on the Prototype JavaScript framework. The download
Expand Down
12 changes: 12 additions & 0 deletions templates/html/index.erb
Expand Up @@ -68,6 +68,18 @@
</div>
</div>

<div class="section">

<div class="section-title">
<h3>UI Controls</h3>
</div> <!-- .section-title -->

<div class="section-content">
<p>The scripty2 UI controls are under heavy development and are still in alpha. Consult the <code>README</code> for instructions on how to include these UI controls in the scripty2 distributable.</p>
</div> <!-- .section-content -->

</div> <!--.section -->

<div class="section">
<div class="section-title">
<h3>Tutorials &amp; Demos</h3>
Expand Down

0 comments on commit 431ec45

Please sign in to comment.