Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kris-B committed Jan 9, 2015
1 parent d782813 commit 85cc346
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,16 @@
#### extension for nanoGALLERY


<br />
<br />
Publish your self-hosted photos simply and automatically to nanoGALLERY.
Content is providing on demand when browsing the albums of the gallery.
Generates thumbnails automatically.

To be used as an add-on for nanoGALLERY (http://nanogallery.brisbois.fr).


<br />
<br />
### Usage

##### Step 1: installation
Expand All @@ -22,8 +25,9 @@ On your webserver:
- you can organize your photos in folders
- in the filenames, you can separate title and description with `$$`
- add leading `@@@@@` to the images to be used as album covers
- edit the `nanoPhotosProvider.cfg` to change the behaviour of the application (for example the size of the thumbnails)
- edit the `nanoPhotosProvider.cfg` to change the behaviour of the application (for example the size of the thumbnails)

<br />
##### Step 2: configure your HTML page

- The page can be located anywhere on your webserver.
Expand All @@ -45,16 +49,20 @@ jQuery(document).ready(function () {
});
});
```

<br />
<br />
##### Step 3: test your page to see the result ;-)

<br />
##### Step 4: add/change content
Add files and folders, or renaname them.
Please note that the thumbnails are never purged, so you may delete the `_thumbnails` folders to force a new generation.

<br />
### Supported image formats
JPEG, GIF and PNG.

<br />
### License
nanoPhotosProvider is licensed under [CC BY-NC 3.0](http://creativecommons.org/licenses/by-nc/3.0/).
Only for personal, non-profit organizations, or open source projects (without any kind of fee), you may use nanoPhotosProvider for free.
Expand Down

0 comments on commit 85cc346

Please sign in to comment.