Permalink
Browse files

add information about common web usage and requirejs usage

  • Loading branch information...
marianoguerra committed Jun 20, 2012
1 parent 71e6b56 commit 5159268b2deeb7a51c95779cae6c17a716b701e5
Showing with 15 additions and 4 deletions.
  1. +15 −4 README.rest
View
@@ -16,15 +16,13 @@ get it
build it
--------
+this builds the parser for the expressions
+
::
cd legojs
./build.sh
-for the minification you will need uglifyjs::
-
- npm install -g uglifyjs
-
try it
------
@@ -37,6 +35,19 @@ http://marianoguerra.github.com/legojs/test
or open test/index.html in your browser
+use it
+------
+
+there are two ways of using it, one is like any normal .js file, just add
+a script tag and import it (see test/index.html for an example)
+
+the other one is using an AMD loader like requirejs, in this case you
+just require the lib, it will return you the legojs function standalone and
+will add the function to the jquery object in $.lego so you can just ignore it
+and use $.lego or use the returned function itself.
+
+for an example of out to use it with requirejs see the main page at index.html
+
author
------

0 comments on commit 5159268

Please sign in to comment.