doc updates

chaijs · Feb 13, 2012 · b7d6010 · b7d6010
1 parent 502c09c
commit b7d6010
Show file tree

Hide file tree

Showing 5 changed files with 66 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ Currently supports all modern browsers: IE 9+, Chrome 7+, FireFox 4+, Safari 5+
 
 ## Plugins
 
-The Chai community is growing! Chai allows developers to extend its supported 
+The Chai community is growing! Plugins allow developers to expand Chai's available 
 assertions. Here is what the community has come up with so far:
 
 * [chai-spies](https://github.com/logicalparadox/chai-spies) is a basic spy implementation for chai. It's also
@@ -54,7 +54,7 @@ can be used as a stand-alone or with chai.
 
 (The MIT License)
 
-Copyright (c) 2011 Jake Luer <jake@alogicalparadox.com>
+Copyright (c) 2011-2012 Jake Luer <jake@alogicalparadox.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/docs/data/home/contributor.md b/docs/data/home/contributor.md
@@ -1,5 +1,5 @@
 ---
-  title: For Contributors
+  title: Contributing
   weight: 10
   render-file: false
 ---
@@ -35,4 +35,15 @@ It's also quite simple. Open up `test/browser/index.html` in your nearest browse
 
 If you have made changes to any of the components, you must rebuild the browser package.
 
-      $ make
+      $ make
+
+### Contributors 
+
+     project: chai
+     commits: 145
+     files  : 57
+     authors: 
+       142  Jake Luer               97.9%
+         1  Domenic Denicola        0.7%
+         1  John Firebaugh          0.7%
+         1  Vinay Pulim             0.7%
diff --git a/docs/data/home/help.md b/docs/data/home/help.md
@@ -4,4 +4,4 @@
   render-file: false
 ---
 
-If you have questions or issues, please use this projects [Github Issues](https://github.com/logicalparadox/chai/issues).
+If you have questions or issues, please use this projects [Github Issues](https://github.com/logicalparadox/chai/issues).
diff --git a/docs/data/home/plugins.md b/docs/data/home/plugins.md
@@ -0,0 +1,18 @@
+---
+  title: Plugins
+  weight: 7
+  render-file: false
+---
+
+### Available Plugins
+
+The Chai community is growing! Plugins allow developers to expand Chai's available 
+assertions. Here is what the community has come up with so far:
+
+* [chai-spies](https://github.com/logicalparadox/chai-spies) is a basic spy implementation for chai. It's also
+a good resource for building chai plugins that work in both node.js and the browser.
+* [chai-jquery](https://github.com/jfirebaugh/chai-jquery) by [@jfirebaugh](https://github.com/jfirebaugh)
+provides deep jQuery integration with chai `should` and `expect`.
+* [jack](https://github.com/vesln/jack) by [@vesln](https://github.com/vesln) is a mock/stub library that 
+can be used as a stand-alone or with chai.
+
diff --git a/docs/out/index.html b/docs/out/index.html
@@ -42,9 +42,11 @@
         </li>
         <li><a href="#styles" class="scroll">Assertion Styles</a>
         </li>
+        <li><a href="#plugins" class="scroll">Plugins</a>
+        </li>
         <li><a href="#help" class="scroll">Getting Help</a>
         </li>
-        <li><a href="#contributor" class="scroll">For Contributors</a>
+        <li><a href="#contributor" class="scroll">Contributing</a>
         </li>
       </ul>
       <ul class="code">
@@ -149,13 +151,31 @@ <h3>Assert</h3>
   assert.length(foo, <span class="number">3</span>, <span class="string">'foo`s value has a length of 3'</span>);
   assert.length(beverages.tea, <span class="number">3</span>, <span class="string">'beverages has 3 types of tea'</span>);</code></pre>
 
+        </section>
+        <h1 id="plugins-section"><a name="plugins">Plugins</a>
+        </h1>
+        <section><h3>Available Plugins</h3>
+<p>The Chai community is growing! Plugins allow developers to expand Chai&apos;s available 
+assertions. Here is what the community has come up with so far:
+
+</p>
+<ul>
+<li><a href="https://github.com/logicalparadox/chai-spies">chai-spies</a> is a basic spy implementation for chai. It&apos;s also
+a good resource for building chai plugins that work in both node.js and the browser.</li>
+<li><a href="https://github.com/jfirebaugh/chai-jquery">chai-jquery</a> by <a href="https://github.com/jfirebaugh">@jfirebaugh</a>
+provides deep jQuery integration with chai <code>should</code> and <code>expect</code>.</li>
+<li><a href="https://github.com/vesln/jack">jack</a> by <a href="https://github.com/vesln">@vesln</a> is a mock/stub library that 
+can be used as a stand-alone or with chai.</li>
+</ul>
+
         </section>
         <h1 id="help-section"><a name="help">Getting Help</a>
         </h1>
-        <section><p>If you have questions or issues, please use this projects <a href="https://github.com/logicalparadox/chai/issues">Github Issues</a>.</p>
+        <section><p>If you have questions or issues, please use this projects <a href="https://github.com/logicalparadox/chai/issues">Github Issues</a>.
+</p>
 
         </section>
-        <h1 id="contributor-section"><a name="contributor">For Contributors</a>
+        <h1 id="contributor-section"><a name="contributor">Contributing</a>
         </h1>
         <section><h3>Developing</h3>
 <p>Please avoid making changes to the browser versions of chai if you are developing in the browser. All
@@ -188,6 +208,15 @@ <h3>Building</h3>
 
 </p>
 <pre><code>  $ make</code></pre>
+<h3>Contributors</h3>
+<pre><code> project: chai
+ commits: 145
+ files  : 57
+ authors: 
+   142  Jake Luer               97.9%
+     1  Domenic Denicola        0.7%
+     1  John Firebaugh          0.7%
+     1  Vinay Pulim             0.7%</code></pre>
 
         </section>
       </article>