doc/index.html in brauser-2.0.0 vs doc/index.html in brauser-2.0.1
- old
+ new
@@ -4,11 +4,11 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII" />
<title>
File: README
- — Documentation by YARD 0.8.3
+ — Documentation by YARD 0.8.4.1
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
@@ -59,45 +59,47 @@
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
- <div id="content"><div id='filecontents'><h1>brauser</h1>
+ <div id="content"><div id='filecontents'><h1 id="brauser">brauser</h1>
-<p><a href="http://travis-ci.org/ShogunPanda/brauser"><img src="https://secure.travis-ci.org/ShogunPanda/brauser.png?branch=master" alt="Build Status"></a>
-<a href="https://gemnasium.com/ShogunPanda/brauser"><img src="https://gemnasium.com/ShogunPanda/brauser.png?travis" alt="Dependency Status"></a>
-<a href="https://codeclimate.com/github/ShogunPanda/brauser"><img src="https://codeclimate.com/github/ShogunPanda/brauser.png" alt="Code Climate"></a></p>
+<p><a href="http://travis-ci.org/ShogunPanda/brauser"><img src="https://secure.travis-ci.org/ShogunPanda/brauser.png?branch=master" alt="Build Status" /></a>
+<a href="https://gemnasium.com/ShogunPanda/brauser"><img src="https://gemnasium.com/ShogunPanda/brauser.png?travis" alt="Dependency Status" /></a>
+<a href="https://codeclimate.com/github/ShogunPanda/brauser"><img src="https://codeclimate.com/github/ShogunPanda/brauser.png" alt="Code Climate" /></a></p>
<p>A framework agnostic browser detection and querying helper.</p>
-<p><a href="http://sw.cow.tc/brauser">http://sw.cow.tc/brauser</a></p>
+<p>http://sw.cow.tc/brauser</p>
-<p><a href="http://rdoc.info/gems/brauser">http://rdoc.info/gems/brauser</a></p>
+<p>http://rdoc.info/gems/brauser</p>
-<h2>Description</h2>
+<h2 id="description">Description</h2>
<p>Brauser is a framework agnostic helper that helps you in targeting your applications against most diffused browsers.</p>
-<h3>Installation</h3>
+<h3 id="installation">Installation</h3>
<p>Brauser comes with a Ruby on Rails hooks (more framework to follow), so for Rails you have just to add this to your Gemfile:</p>
-<pre class="code ruby"><code><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>brauser</span><span class='tstring_end'>"</span></span>
-</code></pre>
+<p><code>ruby
+gem "brauser"
+</code></p>
<p>Once done that, every controller in your application will have a <code>browser</code> method (also extended to views/layout via <code>helper_method</code>).</p>
-<p>If you don't use Rails, you can instantiate a new browser by including the gem in your code and by doing something like this:</p>
+<p>If you don’t use Rails, you can instantiate a new browser by including the gem in your code and by doing something like this:</p>
-<pre class="code ruby"><code><span class='id identifier rubyid_browser'>browser</span> <span class='op'>=</span> <span class='const'>Brauser</span><span class='op'>::</span><span class='const'>Browser</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>USER_AGENT_HEADER</span><span class='comma'>,</span> <span class='const'>ACCEPT_LANGUAGE_HEADER</span><span class='rparen'>)</span>
-</code></pre>
+<p><code>ruby
+browser = Brauser::Browser.new(USER_AGENT_HEADER, ACCEPT_LANGUAGE_HEADER)
+</code></p>
<p>where the first argument is the HTTP header <code>User-Agent</code>, and the second is the HTTP header <code>Accept-Language</code>.</p>
-<p>For the rest of this document, let's assume you use Chrome 1.2.3 on Mac OS X.</p>
+<p>For the rest of this document, let’s assume you use Chrome 1.2.3 on Mac OS X.</p>
-<h3>Getting browser information</h3>
+<h3 id="getting-browser-information">Getting browser information</h3>
<p>Once you instantiate the browser, you can query the browser about <code>name</code>, <code>version</code> and <code>platform</code>. You can also get readable name and platforms via <code>readable_name</code> and <code>platform_name</code>.</p>
<p>The version is returned as a <code>String</code>, and you can use <code>Brauser::Browser.compare_versions</code> to compare against another version.</p>
@@ -105,172 +107,183 @@
<p>Also, you can get global information using <code>browser.to_s</code> or <code>browser.classes</code>. This will return an array or a string already formatted to be used in your views to scope your CSS.</p>
<p>For example, if you do this in a ERB view:</p>
-<pre class="code html"><code><body class="<%= browser.classes %>">
+<p><code>html
+<body class="<%= browser.classes %>">
...
-</code></pre>
+</code></p>
<p>The view will get compiled to this:</p>
-<pre class="code html"><code><body class="chrome version-1 version-1_2 version-1_2_3 platform-osx">
+<p><code>html
+<body class="chrome version-1 version-1_2 version-1_2_3 platform-osx">
...
-</code></pre>
+</code></p>
<p>And thus scoping your CSS will be trivial.</p>
-<h3>Querying the browser</h3>
+<h3 id="querying-the-browser">Querying the browser</h3>
<p>Brauser supports querying about name (method <code>is</code>), version (method <code>v</code>), platform (method <code>on</code>) and language (method <code>accepts</code>).</p>
<p>The <code>is</code> method queries about a browser name (or a list of names) and optionally by version and platform:</p>
-<pre class="code ruby"><code><span class='comment'># We talk about the ending ? later.
-</span><span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_is?'>is?</span><span class='lparen'>(</span><span class='symbol'>:chrome</span><span class='rparen'>)</span>
-<span class='comment'># => true
-</span><span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_is?'>is?</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:msie</span><span class='comma'>,</span> <span class='symbol'>:firefox</span><span class='rbracket'>]</span><span class='rparen'>)</span>
-<span class='comment'># => false
-</span><span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_is?'>is?</span><span class='lparen'>(</span><span class='symbol'>:chrome</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='symbol'>:lt</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>2</span><span class='tstring_end'>"</span></span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='symbol'>:osx</span><span class='rparen'>)</span>
-<span class='comment'># => true
-</span><span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_is?'>is?</span><span class='lparen'>(</span><span class='symbol'>:chrome</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>>= 3</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:windows</span><span class='rparen'>)</span>
-<span class='comment'># => false
-</span></code></pre>
+<p><code>ruby
+# We talk about the ending ? later.
+browser.is?(:chrome)
+# => true
+browser.is?([:msie, :firefox])
+# => false
+browser.is?(:chrome, {:lt => "2"}, :osx)
+# => true
+browser.is?(:chrome, ">= 3", :windows)
+# => false
+</code></p>
<p>The method <code>is</code> is the only which supports direct internal propagation to version and platform.</p>
<p>The <code>v</code> method queries about the browser version. You can specify the comparison with an hash or a little expression.</p>
<p>In the case of hash, the syntax is <code>{:operator => value}</code>, where <code>:operator</code> is one of <code>[:lt, :lte, :eq, :gte, :gt]</code> and value can be a Float or a String.</p>
-<p>In the case of expression, the syntax is <code>OPERATOR VALUE && ..</code>, where <code>OPERATOR</code> is one of <code>["<", "<=", "=", "==", ">=", ">"]</code> and value specifies the version.</p>
+<p>In the case of expression, the syntax is <code>OPERATOR VALUE && ..</code>, where <code>OPERATOR</code> is one of <code>["<", "<=", "=", "==", ">=", ">"]</code> and value specifies the version.</p>
<p>Examples:</p>
-<pre class="code ruby"><code><span class='comment'># Those two methods are equivalent.
-</span><span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_v?'>v?</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='symbol'>:lt</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>2</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:gt</span> <span class='op'>=></span> <span class='int'>1</span><span class='rbrace'>}</span><span class='rparen'>)</span>
-<span class='comment'># => true
-</span><span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_is?'>is?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>< 2 && > 1</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
-<span class='comment'># => true
-</span></code></pre>
+<p><code>ruby
+# Those two methods are equivalent.
+browser.v?({:lt => "2", :gt => 1})
+# => true
+browser.is?("< 2 && > 1")
+# => true
+</code></p>
<p>The method <code>on</code> check is the current browser in one of the specifed platform. The platform should be passed as <code>Symbol</code>.</p>
-<pre class="code ruby"><code><span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_on?'>on?</span><span class='lparen'>(</span><span class='symbol'>:osx</span><span class='rparen'>)</span>
-<span class='comment'># => true
-</span><span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_on?'>on?</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:windows</span><span class='comma'>,</span> <span class='symbol'>:ios</span><span class='rbracket'>]</span><span class='rparen'>)</span>
-<span class='comment'># => false
-</span></code></pre>
+<p><code>ruby
+browser.on?(:osx)
+# => true
+browser.on?([:windows, :ios])
+# => false
+</code></p>
<p>At the end, the method <code>accepts</code> checks if the browser accepts one of the specified languages. Languages should be passed as language codes in <code>String</code>.</p>
-<pre class="code ruby"><code><span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_accepts?'>accepts?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>en</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
-<span class='comment'># => true
-</span><span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_accepts?'>accepts?</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>de</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>es</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
-<span class='comment'># => false
-</span></code></pre>
+<p><code>ruby
+browser.accepts?("en")
+# => true
+browser.accepts?(["de", "es"])
+# => false
+</code></p>
-<p>Every query method exists in two forms: the concatenation one (the method name doesn't end with a <code>?</code>.</p>
+<p>Every query method exists in two forms: the concatenation one (the method name doesn’t end with a <code>?</code>.</p>
<p>The former return a <code>Query</code> object, which supports the same query method of the browser and thus enables concatenation.</p>
-<p>The latter return a boolean object, and it's equivalent to calling <code>result</code> on the query after concatenation.</p>
+<p>The latter return a boolean object, and it’s equivalent to calling <code>result</code> on the query after concatenation.</p>
<p>Ideally, you should use the <code>?</code> version to end the query and fetch the result.</p>
-<pre class="code ruby"><code><span class='comment'># These expressions are equivalent.
-</span><span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_is?'>is?</span><span class='lparen'>(</span><span class='symbol'>:chrome</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='symbol'>:lt</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>2</span><span class='tstring_end'>"</span></span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='symbol'>:osx</span><span class='rparen'>)</span>
-<span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_is'>is</span><span class='lparen'>(</span><span class='symbol'>:chrome</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='symbol'>:lt</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>2</span><span class='tstring_end'>"</span></span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='symbol'>:osx</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span>
-<span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_is'>is</span><span class='lparen'>(</span><span class='symbol'>:chrome</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_v'>v</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='symbol'>:lt</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>2</span><span class='tstring_end'>"</span></span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_on?'>on?</span><span class='lparen'>(</span><span class='symbol'>:osx</span><span class='rparen'>)</span>
-<span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_is'>is</span><span class='lparen'>(</span><span class='symbol'>:chrome</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_v'>v</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='symbol'>:lt</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>2</span><span class='tstring_end'>"</span></span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_on'>on</span><span class='lparen'>(</span><span class='symbol'>:osx</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span>
-</code></pre>
+<p><code>ruby
+# These expressions are equivalent.
+browser.is?(:chrome, {:lt => "2"}, :osx)
+browser.is(:chrome, {:lt => "2"}, :osx).result
+browser.is(:chrome).v({:lt => "2"}).on?(:osx)
+browser.is(:chrome).v({:lt => "2"}).on(:osx).result
+</code></p>
<p>Finally, Brauser support dynamic query operator to write simple queries without using concatenation.</p>
<p>You construct the method just using operator specified above, separating method name and method arguments with a <code>_</code> and different methods with a <code>__</code>.</p>
<p>For the version, use the expression form but use symbol operators and replace <code>.</code> with <code>_</code> and <code>&&</code> with <code>and</code>.</p>
<p>Example:</p>
-<pre class="code ruby"><code><span class='comment'># These expressions are equivalent.
-</span><span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_is'>is</span><span class='lparen'>(</span><span class='symbol'>:chrome</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_v'>v</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>< 2 && > 1.2</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_on'>on</span><span class='lparen'>(</span><span class='symbol'>:osx</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span>
-<span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_is_chrome__v_lt_2_and_gt_1_2__on_osx'>is_chrome__v_lt_2_and_gt_1_2__on_osx</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span>
+<p>```ruby
+# These expressions are equivalent.
+browser.is(:chrome).v(“< 2 && > 1.2”).on(:osx).result
+browser.is_chrome__v_lt<em>2_and_gt</em>1_2__on_osx.result</p>
-<span class='comment'># These expressions are equivalent.
-</span><span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_is'>is</span><span class='lparen'>(</span><span class='symbol'>:chrome</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_v'>v</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>< 2 && > 1.2</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_on?'>on?</span><span class='lparen'>(</span><span class='symbol'>:osx</span><span class='rparen'>)</span>
-<span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_is_chrome__v_lt_2_and_gt_1_2__on_osx?'>is_chrome__v_lt_2_and_gt_1_2__on_osx?</span>
-</code></pre>
+<h1 id="these-expressions-are-equivalent">These expressions are equivalent.</h1>
+<p>browser.is(:chrome).v(“< 2 && > 1.2”).on?(:osx)
+browser.is_chrome__v_lt<em>2_and_gt</em>1_2__on_osx?
+```</p>
-<h3>Adding new browsers</h3>
+<h3 id="adding-new-browsers">Adding new browsers</h3>
<p>To add new browsers, simply call <code>register_browser</code>.</p>
<p>This methods accepts a single entry or an array of entries in the following format: <code>[name, name_match, version_match, label]</code>:</p>
<ul>
-<li><code>name</code> is the name of the browser. Should be a <code>Symbol</code>.</li>
-<li><code>name_match</code> is a <code>Regexp</code> to match against the user agent to detect the current browser.</li>
-<li><code>version_match</code> is a <code>Regexp</code> which last capture group holds the version of the browser.</li>
-<li><code>label</code> is the human readable name of the browser.</li>
+ <li><code>name</code> is the name of the browser. Should be a <code>Symbol</code>.</li>
+ <li><code>name_match</code> is a <code>Regexp</code> to match against the user agent to detect the current browser.</li>
+ <li><code>version_match</code> is a <code>Regexp</code> which last capture group holds the version of the browser.</li>
+ <li><code>label</code> is the human readable name of the browser.</li>
</ul>
<p>For example, for Google Chrome the call should be:</p>
-<pre class="code ruby"><code><span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_register_browser'>register_browser</span><span class='lparen'>(</span><span class='symbol'>:chrome</span><span class='comma'>,</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>((chrome)|(chromium))</span><span class='regexp_end'>/i</span></span><span class='comma'>,</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>(.+Chrom[a-z]+\/)([a-z0-9.]+)</span><span class='regexp_end'>/i</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Google Chrome</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
-</code></pre>
+<p><code>ruby
+browser.register_browser(:chrome, /((chrome)|(chromium))/i, /(.+Chrom[a-z]+\/)([a-z0-9.]+)/i, "Google Chrome")
+</code></p>
-<h3>Adding new platforms</h3>
+<h3 id="adding-new-platforms">Adding new platforms</h3>
<p>To add new platforms, simply call <code>register_platform</code>.</p>
<p>This method accepts a single entry or an array of entries in the following format: <code>[name, matcher, label]</code>:</p>
<ul>
-<li><code>name</code> is the name of the platform. Should be a <code>Symbol</code>.</li>
-<li><code>matcher</code> is a <code>Regexp</code> to match against the user agent to detect the current platform.</li>
-<li><code>label</code> is the human readable name of the platform.</li>
+ <li><code>name</code> is the name of the platform. Should be a <code>Symbol</code>.</li>
+ <li><code>matcher</code> is a <code>Regexp</code> to match against the user agent to detect the current platform.</li>
+ <li><code>label</code> is the human readable name of the platform.</li>
</ul>
<p>For example, for Mac OS X the call should be:</p>
-<pre class="code ruby"><code><span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_register_platform'>register_platform</span><span class='lparen'>(</span><span class='symbol'>:osx</span><span class='comma'>,</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>mac|macintosh|mac os x</span><span class='regexp_end'>/i</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Apple MacOS X</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
-</code></pre>
+<p><code>ruby
+browser.register_platform(:osx, /mac|macintosh|mac os x/i, "Apple MacOS X")
+</code></p>
-<h3>Adding new languages</h3>
+<h3 id="adding-new-languages">Adding new languages</h3>
<p>To add new languages, simply call <code>register_language</code>.</p>
<p>This method accepts a single pair of code and label or an hash where keys are language code and values are labels.</p>
<p>For example, for Italian the call should be:</p>
-<pre class="code ruby"><code><span class='id identifier rubyid_browser'>browser</span><span class='period'>.</span><span class='id identifier rubyid_register_language'>register_language</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>it</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Italian</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
-</code></pre>
+<p><code>ruby
+browser.register_language("it", "Italian")
+</code></p>
-<h2>Contributing to brauser</h2>
+<h2 id="contributing-to-brauser">Contributing to brauser</h2>
<ul>
-<li>Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.</li>
-<li>Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.</li>
-<li>Fork the project.</li>
-<li>Start a feature/bugfix branch.</li>
-<li>Commit and push until you are happy with your contribution.</li>
-<li>Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.</li>
-<li>Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.</li>
+ <li>Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet.</li>
+ <li>Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it.</li>
+ <li>Fork the project.</li>
+ <li>Start a feature/bugfix branch.</li>
+ <li>Commit and push until you are happy with your contribution.</li>
+ <li>Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.</li>
+ <li>Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.</li>
</ul>
-<h2>Copyright</h2>
+<h2 id="copyright">Copyright</h2>
-<p>Copyright (C) 2013 and above Shogun (<a href="mailto:shogun_panda@me.com">shogun_panda@me.com</a>).</p>
+<p>Copyright (C) 2013 and above Shogun (shogun_panda@me.com).</p>
-<p>Licensed under the MIT license, which can be found at <a href="http://www.opensource.org/licenses/mit-license.php">http://www.opensource.org/licenses/mit-license.php</a>.</p>
+<p>Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.</p>
</div></div>
<div id="footer">
- Generated on Sat Feb 2 17:47:18 2013 by
+ Generated on Fri Feb 8 08:12:31 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
- 0.8.3 (ruby-1.9.3).
+ 0.8.4.1 (ruby-1.9.3).
</div>
</body>
</html>
\ No newline at end of file