From 013c3d41db1219a7a2b16bc1939a6263df0a7156 Mon Sep 17 00:00:00 2001 From: Daniel Stocks Date: Wed, 28 Apr 2010 12:30:43 +0200 Subject: [PATCH] A basis usage example is now in readme --- README.rst | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 982136c7..0eb60ca3 100644 --- a/README.rst +++ b/README.rst @@ -26,4 +26,36 @@ Use a custom feed from your Flickr account or any other external feed to display Built for performance ----------------------------- -Galleria is built to perform at it's best regardless of browser environment using clever interpolation methods and jQuery's appraised animations. \ No newline at end of file +Galleria is built to perform at it's best regardless of browser environment using clever interpolation methods and jQuery's appraised animations. + + +Basic Usage +===== +Include jQuery and Galleria on your web page. + +Use the Galleria.loadTheme() to load a Galleria theme.:: + + + +Add images +---------- +There are several ways of adding image data to your gallery, but the simplets way is probably to add some HTML. + +Just put the images inside any container on the site.:: + +
+ Another text +
+ +Activate Galleria +----------------- +When DOM is ready, you can run Galleria:: + + + +The galleria function takes two arguments, *theme* and *options*. If no theme is specified, the last theme loaded is used. The options argument is an object with Galleria options that you can use. See the options documentation for a complete list. \ No newline at end of file