Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

README.md improvment

  • Loading branch information...
commit 3ac254a18fcf8d5c4fdd09a29fa1f38e6da64ba6 1 parent a321309
Jerome Etienne authored
Showing with 25 additions and 19 deletions.
  1. +3 −2 Makefile
  2. +14 −11 README.md
  3. +8 −6 index.html
5 Makefile
View
@@ -25,10 +25,11 @@ deploy: build deployGhPage
deployGhPage:
rm -rf /tmp/$(PROJECT_NAME)GhPages
(cd /tmp && git clone git@github.com:jeromeetienne/$(PROJECT_NAME).git $(PROJECT_NAME)GhPages)
- (cd /tmp/$(PROJECT_NAME)GhPages && git push origin :gh-pages)
+ (cd /tmp/$(PROJECT_NAME)GhPages && git checkout gh-pages || true )
+ (cd /tmp/$(PROJECT_NAME)GhPages && git push origin :gh-pages || true )
(cd /tmp/$(PROJECT_NAME)GhPages && git symbolic-ref HEAD refs/heads/gh-pages)
(cd /tmp/$(PROJECT_NAME)GhPages && rm .git/index)
(cd /tmp/$(PROJECT_NAME)GhPages && git clean -fdx)
- cp -a examples src Makefile *.*README.md /tmp/$(PROJECT_NAME)GhPages
+ cp -a examples src Makefile *.* /tmp/$(PROJECT_NAME)GhPages
(cd /tmp/$(PROJECT_NAME)GhPages && git add . && git commit -a -m "Another deployement" && git push origin gh-pages)
#rm -rf /tmp/$(PROJECT_NAME)GhPages
25 README.md
View
@@ -1,16 +1,19 @@
-# jQuery.qrcode.js
+# jquery.qrcode.js
-With jQuery.qrcode.js you can easily add qrcode to your webpages.
-It is standalone, no external services which go on and off, or add latency
-while loading. It is based on a <a href='http://www.d-project.com/qrcode/index.html'>library</a>
-which build qrcode in various language. jQuery.qrcode.js wraps it to make it easy
-to include in your own code.
+<a href='http://jeromeetienne.github.com/jquery-qrcode'>jquery.qrcode.js</a>
+is *jquery plugin for a pure browser qrcode generation*.
+It allow you to easily add qrcode to your webpages.
+It is standalone, less than 4k after minify+gzip, no image download.
+It doesnt rely on external services which go on and off, or add latency while loading.
+It is based on a <a href='http://www.d-project.com/qrcode/index.html'>library</a>
+which build qrcode in various language. <a href='http://jeromeetienne.github.com/jquery-qrcode'>jquery.qrcode.js</a> wraps
+it to make it easy to include in your own code.
-Show, dont tell, here is a <a href='examples/demo.html'>demo</a>
+Show, dont tell, here is a <a href='examples/basic.html'>example</a>
## How to Use It
-First include it in your webpage with the usual script tag
+Let me walk you thru it. First include it in your webpage with the usual script tag
<script type="text/javascript" src="jquery.qrcode.min.js"></script>
@@ -21,13 +24,13 @@ a div
Then you add the *qrcode* in this container by
- jQuery('#qrcode').qrcode("this plugin is great");
+ jquery('#qrcode').qrcode("this plugin is great");
This is it. see it <a href='examples/basic.html'>live</a>.
## Conclusion
-
-MicroEvent.js is available on github <a href='https://github.com/jeromeetienne/jquery-qrcode'>here</a>
+<a href='http://jeromeetienne.github.com/jquery-qrcode'>jquery.qrcode.js</a> is available on github
+<a href='https://github.com/jeromeetienne/jquery-qrcode'>here</a>
under <a href='https://github.com/jeromeetienne/jquery-qrcode.js/blob/master/MIT-LICENSE.txt'>MIT license</a>.
If you hit bugs, fill issues on github.
Feel free to fork, modify and have fun with it :)
14 index.html
View
@@ -9,16 +9,18 @@
<body>
<div id="jquery.qrcode.js"
><h1
- >jQuery.qrcode.js</h1
+ >jquery.qrcode.js</h1
><p
- >With jQuery.qrcode.js you can easily add qrcode to your webpages. It is standalone, no external services which go on and off, or add latency while loading. It is based on a <a href='http://www.d-project.com/qrcode/index.html'>library</a> which build qrcode in various language. jQuery.qrcode.js wraps it to make it easy to include in your own code.</p
+ ><a href='http://jeromeetienne.github.com/jquery-qrcode'>jquery.qrcode.js</a> is <em
+ >jquery plugin for a pure browser qrcode generation</em
+ >. It allow you to easily add qrcode to your webpages. It is standalone, less than 4k after minify+gzip, no image download. It doesnt rely on external services which go on and off, or add latency while loading. It is based on a <a href='http://www.d-project.com/qrcode/index.html'>library</a> which build qrcode in various language. <a href='http://jeromeetienne.github.com/jquery-qrcode'>jquery.qrcode.js</a> wraps it to make it easy to include in your own code.</p
><p
- >Show, dont tell, here is a <a href='examples/demo.html'>demo</a></p
+ >Show, dont tell, here is a <a href='examples/basic.html'>example</a></p
><div id="how-to-use-it"
><h2
>How to Use It</h2
><p
- >First include it in your webpage with the usual script tag</p
+ >Let me walk you thru it. First include it in your webpage with the usual script tag</p
><pre
><code
>&lt;script type=&quot;text/javascript&quot; src=&quot;jquery.qrcode.min.js&quot;&gt;&lt;/script&gt;
@@ -37,7 +39,7 @@
> in this container by</p
><pre
><code
- >jQuery('#qrcode').qrcode(&quot;this plugin is great&quot;);
+ >jquery('#qrcode').qrcode(&quot;this plugin is great&quot;);
</code
></pre
><p
@@ -47,7 +49,7 @@
><h2
>Conclusion</h2
><p
- >MicroEvent.js is available on github <a href='https://github.com/jeromeetienne/jquery-qrcode'>here</a> under <a href='https://github.com/jeromeetienne/jquery-qrcode.js/blob/master/MIT-LICENSE.txt'>MIT license</a>. If you hit bugs, fill issues on github. Feel free to fork, modify and have fun with it :)</p
+ ><a href='http://jeromeetienne.github.com/jquery-qrcode'>jquery.qrcode.js</a> is available on github <a href='https://github.com/jeromeetienne/jquery-qrcode'>here</a> under <a href='https://github.com/jeromeetienne/jquery-qrcode.js/blob/master/MIT-LICENSE.txt'>MIT license</a>. If you hit bugs, fill issues on github. Feel free to fork, modify and have fun with it :)</p
></div
></div
>
Please sign in to comment.
Something went wrong with that request. Please try again.