Skip to content

Commit

Permalink
improved documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathan-fielding committed Dec 23, 2013
1 parent 66b7705 commit 59cb9fb
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<div class="container">
<img src="docs/images/ssm-logo.png" class="logo">

<h1>Simple State Manager</h1>
<h1>Simple State Manager 2.1.0</h1>

<p class="lead">Simple State Manager (SSM for short) is a javascript state manager for responsive websites. It is built to be light weight, has no dependencies (except javascript of course) and aims to be really easy to simply drop into your project ready to use.</p>
<a class="btn btn-large btn-primary" href="https://github.com/jonathan-fielding/SimpleStateManager/archive/master.zip">Download</a>
Expand Down Expand Up @@ -183,7 +183,12 @@ <h3>Add a new config option</h3>
return false;
}
}});</pre>
<p>This is the same method that SimpleStateManager uses to add the maxWidth and minWidth config options so the example above is taken direct from the SimpleStateManager source</p>
<p>This is the same method that SimpleStateManager uses to add the maxWidth config option so the example above is taken direct from the SimpleStateManager source. As you will notice we can use <code>this</code> to access the state we are testing to determine whether the test should pass or fail.</p>
<p>Some simple examples of tests that you could add to SimpleStateManager are:</p>
<ul>
<li>Viewport minimum and maximum height tests</li>
<li>Test to see if touch events are avalible</li>
</ul>

<h3>Full API</h3>

Expand Down Expand Up @@ -314,6 +319,13 @@ <h2>Browser Support</h2>
<h2>Release Log</h2>
<p>SimpleStateManager follows <a href="http://semver.org/">Semantic Versioning 2.0.0</a></p>

<h3>2.1.0 - December 23, 2013</h3>
<ul>
<li>Added config option API which allows you to add your own SimpleStateManager config options along with the test to see if they are valid</li>
<li>Rewrote how testing of minWidth and maxWidth is handled to use the new config option API</li>
<li>Added new unit tests to improve code coverage</li>
</ul>

<h3>2.0.3 - October 7, 2013</h3>
<ul>
<li>Fixed issue where browser width was updated incorrectly</li>
Expand Down

0 comments on commit 59cb9fb

Please sign in to comment.