jepler/jquery-qrcode
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

README.md improvment

Browse source
This commit is contained in:
Jerome Etienne 2011-04-07 13:57:40 +02:00
parent a321309186
commit 3ac254a18f
3 changed files with 25 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
Makefile
View file

@ -25,10 +25,11 @@ deploy: build deployGhPage
deployGhPage: deployGhPage:
rm -rf /tmp/$(PROJECT_NAME)GhPages rm -rf /tmp/$(PROJECT_NAME)GhPages
(cd /tmp && git clone git@github.com:jeromeetienne/$(PROJECT_NAME).git $(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 && git symbolic-ref HEAD refs/heads/gh-pages)
(cd /tmp/$(PROJECT_NAME)GhPages && rm .git/index) (cd /tmp/$(PROJECT_NAME)GhPages && rm .git/index)
(cd /tmp/$(PROJECT_NAME)GhPages && git clean -fdx) (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) (cd /tmp/$(PROJECT_NAME)GhPages && git add . && git commit -a -m "Another deployement" && git push origin gh-pages)
#rm -rf /tmp/$(PROJECT_NAME)GhPages #rm -rf /tmp/$(PROJECT_NAME)GhPages

25
README.md
View file

@ -1,16 +1,19 @@
# jQuery.qrcode.js # jquery.qrcode.js
With jQuery.qrcode.js you can easily add qrcode to your webpages. <a href='http://jeromeetienne.github.com/jquery-qrcode'>jquery.qrcode.js</a>
It is standalone, no external services which go on and off, or add latency is *jquery plugin for a pure browser qrcode generation*.
while loading. It is based on a <a href='http://www.d-project.com/qrcode/index.html'>library</a> It allow you to easily add qrcode to your webpages.
which build qrcode in various language. jQuery.qrcode.js wraps it to make it easy It is standalone, less than 4k after minify+gzip, no image download.
to include in your own code. 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 ## 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> <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 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>. This is it. see it <a href='examples/basic.html'>live</a>.
## Conclusion ## Conclusion
<a href='http://jeromeetienne.github.com/jquery-qrcode'>jquery.qrcode.js</a> is available on github
MicroEvent.js is available on github <a href='https://github.com/jeromeetienne/jquery-qrcode'>here</a> <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>. 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. If you hit bugs, fill issues on github.
Feel free to fork, modify and have fun with it :) Feel free to fork, modify and have fun with it :)

14
index.html
View file

@ -9,16 +9,18 @@
<body> <body>
<div id="jquery.qrcode.js" <div id="jquery.qrcode.js"
><h1 ><h1
>jQuery.qrcode.js</h1 >jquery.qrcode.js</h1
><p ><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 ><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" ><div id="how-to-use-it"
><h2 ><h2
>How to Use It</h2 >How to Use It</h2
><p ><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 ><pre
><code ><code
>&lt;script type=&quot;text/javascript&quot; src=&quot;jquery.qrcode.min.js&quot;&gt;&lt;/script&gt; >&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 > in this container by</p
><pre ><pre
><code ><code
>jQuery('#qrcode').qrcode(&quot;this plugin is great&quot;); >jquery('#qrcode').qrcode(&quot;this plugin is great&quot;);
</code </code
></pre ></pre
><p ><p
@ -47,7 +49,7 @@
><h2 ><h2
>Conclusion</h2 >Conclusion</h2
><p ><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
></div ></div
> >