README.md in web_font-0.0.5 vs README.md in web_font-0.0.6

- old
+ new

@@ -1,8 +1,8 @@ # WebFont -TODO: Write a gem description +WebFont is a Ruby library that will help you download fonts from Google. For now, we support only [Google Font](http://www.google.com/fonts). ## Installation Add this line to your application's Gemfile: @@ -14,12 +14,39 @@ Or install it yourself as: $ gem install web_font +## Dependencies + +WebFont depends on [wget](http://en.wikipedia.org/wiki/Wget). Make sure you have it installed first. + +For Ubuntu: +``` +sudo apt-get install wget +``` + +To download font from Google, you need to have [Google API Key](https://www.google.com/search?q=google+api+key), then set ``GOOGLE_API_KEY`` environment variable. + ## Usage -TODO: Write usage instructions here +```ruby +require 'web_font' + +ENV['GOOGLE_API_KEY'] = '...' +WebFont::Data.path = '/some/where/in/your/disk' + +# First you need to have font index +WebFont::Data.download + +# Then you can download font 'Open Sans' and store it in /users/foo +downloader = WebFont::Downloader.new +downloader.download('Open Sans', '/users/foo') + +# You can also find font in index as well +finder = WebFont::Finder.new +finder.find('Open Sans') +``` ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)