From b0eb4ecba324f8174a111ce688f25671ad4e4d12 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobi=20Sch=C3=A4fer?= Date: Wed, 8 Apr 2015 18:45:09 +0200 Subject: [PATCH] Update and rename README to README.md --- modules/README | 17 ----------------- modules/README.md | 16 ++++++++++++++++ 2 files changed, 16 insertions(+), 17 deletions(-) delete mode 100644 modules/README create mode 100644 modules/README.md diff --git a/modules/README b/modules/README deleted file mode 100644 index 8a0ec3d4..00000000 --- a/modules/README +++ /dev/null @@ -1,17 +0,0 @@ -

HelmaLib is organized into two groups of modules:

- - - -

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 -Jala project!

diff --git a/modules/README.md b/modules/README.md new file mode 100644 index 00000000..48558085 --- /dev/null +++ b/modules/README.md @@ -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 +Jala project!