<commit_before>= blinky

blinky helps you see the light

* plug and play set up for build lights 
* get a build light up and running in a few minutes.

== Why blinky?

Setting up a build light on a new project always seems to be more of a hassle than it should be. Somehow it always seems that no one else has ever dealt with the exact combination of OS, CI Server and build light that you have in your sweaty little hands, and you have to write something from scratch. Again.

blinky is an attempt to fix that.

blinky aims to supply plug and play support for all combinations of
* USB Light Model (or any other USB Device used to indicate build status)
* Operating System
* CI Server
{<img src="https://raw.github.com/perryn/blinky/master/lights.jpg">}[https://raw.github.com/perryn/blinky/master/lights.jpg]
== How do I use blinky?

Plug in your USB light, and then do something like this
    
  require 'rubygems'
  require 'blinky'

  blinky = Blinky.new.light 
  light.watch_cctray_server http://your.ci.server/cctray.xml 
  
Or, with basic authentication

  light.watch_cctray_server http://your.ci.server/cctray.xml, {:user => 'user', :password => 'password'}  
  
Or, you can just control the light directly
  
  light.success!
  light.failure!
  light.building!
  light.warning!
  light.off!
  
== What if I have more than one light? 

Want to plug in more than one light on the same machine? <commit_msg>doco tweak<commit_after>= blinky

blinky helps you see the light

* plug and play set up for build lights 
* get a build light up and running in a few minutes.

== Why blinky?

Setting up a build light on a new project always seems to be more of a hassle than it should be. Somehow it always seems that no one else has ever dealt with the exact combination of OS, CI Server and build light that you have in your sweaty little hands, and you have to write something from scratch. Again.

blinky is an attempt to fix that.

blinky aims to supply plug and play support for all combinations of
* USB Light Model (or any other USB Device used to indicate build status)
* Operating System
* CI Server

Heres blinky running three different lights at once:

{<img src="https://raw.github.com/perryn/blinky/master/lights.jpg" height="50%" width="50%">}[https://raw.github.com/perryn/blinky/master/lights.jpg]

== How do I use blinky?

Plug in your USB light, and then do something like this
    
  require 'rubygems'
  require 'blinky'

  blinky = Blinky.new.light 
  light.watch_cctray_server http://your.ci.server/cctray.xml 
  
Or, with basic authentication

  light.watch_cctray_server http://your.ci.server/cctray.xml, {:user => 'user', :password => 'password'}  
  
Or, you can just control the light directly
  
  light.success!
  light.failure!
  light.building!
  light.warning!
  light.off!
  
== What if I have more than one light? 

Want to plug in more than one light on the same machine? 
{'fraction_non_alphanumeric': 0.07668500687757909, 'fraction_numerical': 0.001375515818431912, 'mean_word_length': 3.6995153473344105, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 9, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 4}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2788364', 'n_tokens_mistral': 898, 'n_tokens_neox': 849, 'n_words': 399}