Permalink
Browse files

Updated readme

  • Loading branch information...
lukebayes committed Mar 8, 2011
1 parent d1952ed commit 5c57f19d7587cd6a66109b96c6057d65639932e4
Showing with 10 additions and 27 deletions.
  1. +10 −27 README.textile
View
@@ -1,41 +1,24 @@
h1. Node Should
-'Node Should' is a(nother) implementation of "Shoulda":http://thoughtbot.com/community/ in JavaScript and
-specifically in the "NodeJS":http://nodejs.org/ runtime environment.
+'Node Should' is a(nother) implementation of "Shoulda":http://thoughtbot.com/community/ in JavaScript and specifically in the "NodeJS":http://nodejs.org/ runtime environment.
-This testing framework was developed test-first based on the examples
-found in the "NodeJs library":https://github.com/ry/node/tree/master/test/simple itself.
+This testing framework is still in an experimental state, but is being developed test-first.
-There are most definitely bugs and problems in this code, but it is
-working well enough for me at the moment. If you encounter an issue,
-please let me know by "messaging me on github":http://github.com/lukebayes . Forks and pull requests
-are definitely welcome.
+There are most definitely bugs and problems in this code, but it is working well enough for me at the moment. If you encounter an issue, please let me know by "messaging me on github":http://github.com/lukebayes . Forks and pull requests are definitely welcome.
-The main problem that I set out to solve with this library, is one
-of composite test environments. I really appreciate how Shoulda
-enables shared, general setup code and more specific leaves that
-can take advantage of it.
+The main problem that I set out to solve with this library, is one of composite test environments. I really appreciate how Shoulda enables shared, general setup code and more specific leaves that can take advantage of it.
-Another major reason for building this framework was inherently
-supporting asynchronous tests.
+Another major reason for building this framework was inherently supporting asynchronous tests.
-The ad-hoc assertion testing found in the NodeJs library code is
-obviously good-enough to get by, but suffers from problems with
-error localization, especially when something asynchronous fails.
+The ad-hoc assertion testing found in the NodeJs library code is obviously good-enough to get by, but suffers from problems with error localization, especially when something asynchronous fails.
-To use this framework, take a look at the project in the example/
-folder.
+To use this framework, take a look at the project in the example/ folder.
-You'll probably want to copy the runner.js file found there into
-your project, and add the files found in src/ to a folder in your
-lib/ like, lib/node-should, and get that into your load path.
+You'll probably want to copy the runner.js file found there into your project, and add the files found in src/ to a folder in your lib/ like, lib/node-should, and get that into your load path.
-Once you have taken these two steps, you should be able to run
-your test harness with:
+Once you have taken these two steps, you should be able to run your test harness with:
node runner.js
-If you're interested in more examples of how to write tests using
-this framework, check out the runner.js and test folder for the
-framework itself.
+If you're interested in more examples of how to write tests using this framework, check out the runner.js and test folder for the framework itself.

0 comments on commit 5c57f19

Please sign in to comment.