Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
update version to 0.4.1
Switch to README.md as it's easier to edit
add links to contributors
  • Loading branch information
whomwah committed Aug 16, 2011
1 parent 36c688d commit 6a36635
Show file tree
Hide file tree
Showing 4 changed files with 124 additions and 109 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG
@@ -1,3 +1,7 @@
*0.4.1* (Aug 16th, 2011)

* Compute common patterns only once (5% to 10% speedup) [https://github.com/gioele]

*0.4.0* (Aug 13th, 2011)

* Code optimization: 30% speedup [https://github.com/gioele]
Expand Down
119 changes: 119 additions & 0 deletions README.md
@@ -0,0 +1,119 @@
# rQRCode, Encode QRCodes

## Overview

rQRCode is a library for encoding QR Codes in Ruby. It has a simple interface with all the standard qrcode options. It was adapted from the Javascript library by Kazuhiko Arase.

Let's clear up some rQRCode stuff.

* rQRCode is a __standalone library__ It requires no other libraries. Just Ruby!
* It is an encoding library. You can't decode QR codes with it.
* The interface is simple and assumes you just want to encode a string into a QR code
* QR code is trademarked by Denso Wave inc

## Resources

* wikipedia:: http://en.wikipedia.org/wiki/QR_Code
* Denso-Wave website:: http://www.denso-wave.com/qrcode/index-e.html
* kaywa:: http://qrcode.kaywa.com

## Installing

You may get the latest stable version from Rubygems.

gem install rqrcode

You can also get the latest source from http://github.com/whomwah/rqrcode

git clone git://github.com/whomwah/rqrcode.git

## Tests

To run the tests:

$ rake

## Loading rQRCode Itself

You have installed the gem already, yeah?

require 'rubygems'
require 'rqrcode'

## Simple QRCode generation to screen

```ruby
qr = RQRCode::QRCode.new( 'my string to generate', :size => 4, :level => :h )
puts qr.to_s
#
# Prints:
# xxxxxxx x x x x x xx xxxxxxx
# x x xxx xxxxxx xxx x x
# x xxx x xxxxx x xx x xxx x
# ... etc
```

## Simple QRCode generation to template (RubyOnRails)

```erb
# Controller
@qr = RQRCode::QRCode.new( 'my string to generate', :size => 4, :level => :h )
# View: (minimal styling added)
<style type="text/css">
table {
border-width: 0;
border-style: none;
border-color: #0000ff;
border-collapse: collapse;
}
td {
border-width: 0;
border-style: none;
border-color: #0000ff;
border-collapse: collapse;
padding: 0;
margin: 0;
width: 10px;
height: 10px;
}
td.black { background-color: #000; }
td.white { background-color: #fff; }
</style>
<table>
<% @qr.modules.each_index do |x| %>
<tr>
<% @qr.modules.each_index do |y| %>
<% if @qr.dark?(x,y) %>
<td class="black"/>
<% else %>
<td class="white"/>
<% end %>
<% end %>
</tr>
<% end %>
</table>
```

## Authors

Original author: Duncan Robertson

Special thanks to the following people for submitting patches:

* [Gioele Barabucci](https://github.com/gioele)
* [Rob la Lau](https://github.com/ohreally)
* [Chris Mowforth](http://blog.99th.st)
* [Tore Darell](http://tore.darell.no)
* [Daniel Schierbeck](https://github.com/dasch)
* Vladislav Gorodetskiy

## Contributing
* Fork the project
* Send a pull request
* Don't touch the .gemspec, I'll do that when I release a new version

## Copyright

MIT Licence (http://www.opensource.org/licenses/mit-license.html)
108 changes: 0 additions & 108 deletions README.org

This file was deleted.

2 changes: 1 addition & 1 deletion lib/rqrcode/version.rb
@@ -1,3 +1,3 @@
module RQRCode
VERSION = "0.4.0"
VERSION = "0.4.1"
end

0 comments on commit 6a36635

Please sign in to comment.