Update and rename README to README.md

This commit is contained in:
Tobi Schäfer 2015-04-08 18:45:09 +02:00
parent 69adddafed
commit b0eb4ecba3
2 changed files with 16 additions and 17 deletions

16
modules/README.md Normal file
View file

@ -0,0 +1,16 @@
HelmaLib is organized into several groups of modules:
* **modules/core** which contains extensions to core JavaScript types such as
Object, Array, or Date.
* **modules/helma** which provide new functionality to JavaScript, usually by
wrapping a Java library.
* **modules/jala**, a Git submodule providing the very useful ORF.at libraries for Helma
To use a HelmaLib module in your Helma application, you need to add it to the
app's repositories. The simplest way to do so is by using the `app.addRepository()`
function:
app.addRepository('modules/helma/Search.js');
If you are looking for more Helma libraries, be sure to check out the
<a href="https://opensvn.csie.org/traccgi/jala/wiki">Jala project</a>!