Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.37 KB

README.rdoc

File metadata and controls

39 lines (24 loc) · 1.37 KB
Raw

Render QR codes easily from your Rails 3 application ↑

This gem supports rendering either SVG or PNG format.

SVG, because of it’s vector nature, will scale easily when intended for print. Offering QR endpoints enables others to integrate with your service in possibly interesting ways.

Installation ↑

Add the following to your Gemfile.

gem 'rqrcode-rails3'

If you want to use the PNG format, you will have to have ImageMagick installed on your system. You will also want to add the mini_magick gem to your application’s Gemfile.

gem 'mini_magick'

How to use ↑

In your controller actions, you could return a QR code that links to the current page like this:

respond_to do |format|
  format.html
  format.svg { render :qrcode => request.url }
  format.png { render :qrcode => request.url }
end

Options:

  • :size – This controls how big the QR Code will be. Smallest size will be chosen by default. Set to maintain consistent size.

  • :offset – Padding around the QR Code (e.g. 10)

  • :fill – Background color (e.g “ffffff” or :white)

  • :color – Foreground color for the code (e.g. “000000” or :black)

About ↑

This project was inspired by the first chapter in José Valim’s book Crafting Rails Applications

QR codes are encoded by rqrcode