Skip to content

Commit

Permalink
Fixed Markdown in Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
flipbit committed Apr 18, 2017
1 parent b2d79ad commit 5a617f9
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
#jQuery Image Annotation Plugin
# jQuery Image Annotation Plugin

A jQuery Image Annotation plugin that can create Flickr-like comments on images embedded in web pages.

This plugin works with jQuery ~1.8.1.

Extract [this zip file] [7] into a directory on your web server and navigate to `demo-static.html` or view a [live preview][1].
Extract [this zip file][7] into a directory on your web server and navigate to `demo-static.html` or view a [live preview][1].

###Usage:
### Usage:

To use the plugin you first need to reference the jQuery and jQuery UI libraries in your page. Add
the `jquery.annotate.js` and `annotation.css` files to enable the plugin.
Expand Down Expand Up @@ -60,7 +60,7 @@ The HTML markup for the page looks like this:

A copy of all this code is included in the release.

###Build:
### Build:

A minimized distribution of the plugin and required resources is available in ```dist/```.
To rebuild yourself do:
Expand All @@ -77,55 +77,55 @@ grunt
```dist/js/jquery.annotate.concat.min.js``` includes all of the required javascript
minimized and concated into one file.

###History:
### History:

####Version 1.4 19th January, 2011
#### Version 1.4 19th January, 2011
* Upgraded jQuery to version 1.7.1


####Version 1.3 22nd June, 2009
#### Version 1.3 22nd June, 2009
* Fixed a bug when creating a new annotation via AJAX.
* The Id of the annotation is expected to be returned as a JSON object from the response of the save call, e.g.

`{ "annotation_id": "000001" }`


####Version 1.2 24th April, 2009
#### Version 1.2 24th April, 2009
* Fixed jQuery UI 1.3.2 compatibility.
* Forked source for jQuery 1.2.x and 1.3.x
* Notes now fade in/out - be sure to add correct jQuery UI components.
* Tidied up CSS/positioning.


####Version 1.1: 2nd April, 2009
#### Version 1.1: 2nd April, 2009
* Fixed bug when annotating an image with no previous annotations.


####Version 1.0: 11th March, 2009
#### Version 1.0: 11th March, 2009
* Initial release


###Credits:
### Credits:

Based on the Drupal extension:

Image Annotations by Ronan Berder
hunvreus@gmail.com
[http://drupal.org/project/image_annotate] [2]
[http://drupal.org/user/49057] [3]
[http://teddy.fr] [4]
[http://drupal.org/project/image_annotate][2]
[http://drupal.org/user/49057][3]
[http://teddy.fr][4]


FamFamFam Icons by:
Mark James
[http://www.famfamfam.com/] [5]
[http://www.famfamfam.com/][5]


Trafalgar Square image by:
Maurice
[http://www.flickr.com/photos/mauricedb/2742966709/] [6]
[http://www.flickr.com/photos/mauricedb/2742966709/][6]

###Licence:
### Licence:

Released under the GNU license.

Expand All @@ -135,4 +135,4 @@ Released under the GNU license.
[4]: http://teddy.fr
[5]: http://www.famfamfam.com/
[6]: http://www.flickr.com/photos/mauricedb/2742966709/
[7]: https://github.com/flipbit/jquery-image-annotate/zipball/master
[7]: https://github.com/flipbit/jquery-image-annotate/zipball/master

0 comments on commit 5a617f9

Please sign in to comment.