From b7d601020b1d13f8415bf34669bfce7c8e5cd0ef Mon Sep 17 00:00:00 2001 From: Jake Luer Date: Mon, 13 Feb 2012 14:10:44 -0500 Subject: [PATCH] doc updates --- README.md | 4 ++-- docs/data/home/contributor.md | 15 +++++++++++++-- docs/data/home/help.md | 2 +- docs/data/home/plugins.md | 18 ++++++++++++++++++ docs/out/index.html | 35 ++++++++++++++++++++++++++++++++--- 5 files changed, 66 insertions(+), 8 deletions(-) create mode 100644 docs/data/home/plugins.md diff --git a/README.md b/README.md index 8152ab9cb..410ed8fc8 100644 --- 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 +Copyright (c) 2011-2012 Jake Luer 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 index 9dbb884da..0d2ee6855 100644 --- 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 \ No newline at end of file + $ 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 index 0b66fabec..8800026e2 100644 --- 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). \ No newline at end of file +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 new file mode 100644 index 000000000..79b7eed35 --- /dev/null +++ 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 index d782a9876..513652107 100644 --- a/docs/out/index.html +++ b/docs/out/index.html @@ -42,9 +42,11 @@
  • Assertion Styles
    • +
  • Plugins +
  • Getting Help
    • -
  • For Contributors +
  • Contributing
      • @@ -149,13 +151,31 @@

      Assert

      assert.length(foo, 3, 'foo`s value has a length of 3'); assert.length(beverages.tea, 3, 'beverages has 3 types of tea'); + +

      Plugins +

      +

      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 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 by @jfirebaugh +provides deep jQuery integration with chai should and expect.
        • +
      • jack by @vesln is a mock/stub library that +can be used as a stand-alone or with chai.
        • +
      +

      Getting Help

      -

      If you have questions or issues, please use this projects Github Issues.

      +

      If you have questions or issues, please use this projects Github Issues. +

      -

      For Contributors +

      Contributing

      Developing

      Please avoid making changes to the browser versions of chai if you are developing in the browser. All @@ -188,6 +208,15 @@

      Building

        $ 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%