aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVictor Häggqvist <[email protected]>2018-02-14 20:41:38 +0100
committerVictor Häggqvist <[email protected]>2018-02-14 20:43:25 +0100
commit7ab2a4133f292839a88794c4ab3ea4f4d1c3ed25 (patch)
treefba5f15954be450a501f83dff65fe3c171f21fbc
parentf8bcdcd8814ab602b2852197f450501ba08af341 (diff)
fix readme
-rw-r--r--README.md19
1 files changed, 9 insertions, 10 deletions
diff --git a/README.md b/README.md
index ceb011c..61ddf47 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,25 @@
-Touch Imagelightbox
-==============
+# Touch Imagelightbox
*Notice: master have been reset to version 0.1.5 (with jQuery), if you do want to have old master is still available on old-master or 0.2.0 tag. 0.1.5 should be considered the latest stable release.*
-Imagelightbox was originly created by [Osvaldas Valutis](http://osvaldas.info/image-lightbox-responsive-touch-friendly), though it was only accesible through his site. I put it here to make it more maintainable.
+Imagelightbox was originally created by [Osvaldas Valutis](http://osvaldas.info/image-lightbox-responsive-touch-friendly), though it was only accessible through his site. I put it here to make it more maintainable.
-#How to get it
+## How to get it
Via bower.io `bower install touch-imagelightbox`
Or with git `git clone https://github.com/victorhaggqvist/touch-imagelightbox.git`
Or download the [zip](https://github.com/victorhaggqvist/touch-imagelightbox/archive/master.zip).
-#Requirements
-jQuery (or maby Zepto.js, though unteststed)
+## Requirements
+jQuery
-#How to build
-Image Lightbox is buildt using the Grunt toolchain. The CSS is build using SASS and Compass, which means you need Ruby, the SASS and Compass gems to make it.
+## How to build
+Image Lightbox is build using the Grunt tool chain. The CSS is build using SASS and Compass, which means you need Ruby, the SASS and Compass gems to make it.
-Note: Remenber that you ATM need a alpha build of Compass to make it work with Grunt (`gem install compass --pre`).
+Note: Remember that you ATM need a alpha build of Compass to make it work with Grunt (`gem install compass --pre`).
If you have Node just do a `npm install` then `grunt` and you will have a new build in the `dist/` directory.
-#License
+## License
MIT