README.md in geektool_kit-0.3.0 vs README.md in geektool_kit-0.3.1

- old
+ new

@@ -1,25 +1,42 @@ # GeektoolKit -TODO: Write a gem description +GeektoolKit is tool for generating and running geeklets. ## Installation -Add this line to your application's Gemfile: +The shebang for all the scripts is '#!/usr/bin/env ruby' and Geektool runs scripts without regard to your ruby version manager, so you will want to run - gem 'geektool_kit' + $ sudo gem install geektool_kit -And then execute: +using your system ruby. If you are using rvm, that means you will want to run - $ bundle + $ rvm use system -Or install it yourself as: +before you run any scripts. - $ gem install geektool_kit - ## Usage -TODO: Write usage instructions here +To create the config file and generate the geeklets (in ~/geektool_kit) + + $ geektool_kit setup + +Once the geeklets have been generated, double-clicking their .glet files will add them to Geektool. + +To preview the output for the cpu_meter geeklet: + + $ gk_cpu_meter + $ gk_cpu_meter [-l lines_to_print] [-t "alternate title"] + +To preview the output for the mem_meter geeklet: + + $ gk_mem_meter + $ gk_mem_meter [-l lines_to_print] [-t "alternate title"] + +To preview the output for the cal geeklet: + + $ gk_cal + ## Contributing 1. Fork it ( https://github.com/[my-github-username]/geektool_kit/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`)