Skip to content

Commit

Permalink
Update README, include contributing details.
Browse files Browse the repository at this point in the history
  • Loading branch information
reid committed Aug 16, 2010
1 parent eec9c60 commit 7304e7d
Showing 1 changed file with 35 additions and 10 deletions.
45 changes: 35 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Here you go:
What just happened?
-------------------

Yeti is a command-line tool for launching JavaScript unit tests in a browser and reporting the results without leaving your terminal. It's very similar to [jspec][] in this regard, except yeti is designed to work with existing unmodified YUI-based tests.
Yeti is a command-line tool for launching JavaScript unit tests in a browser and reporting the results without leaving your terminal. Yeti is designed to work with existing unmodified YUI-based tests.

Yeti is designed to help you run tests before you commit. It compliments existing CI tools like Selenium and Hudson which run tests post-commit. Yeti is not a replacement for those tools.

Expand Down Expand Up @@ -68,6 +68,8 @@ Server mode is great for working offline: you can test your commits across A-gra

You can pass the --port option to override port 8000 with your preferred server port. If you do this, be sure to also pass --port when running Yeti as a client.

Yeti doesn't exit automatically when used with server mode. If you're using only 1 browser with server mode (i.e. just running tests on 1 browser on another computer or VM), you may use the `--solo 1` option to have Yeti exit with a summary after all tests run once. This is also handy for scripting Yeti: if a failure occurs, Yeti will exit with a non-zero status code.

Mobile testing made easy
------------------------

Expand All @@ -78,22 +80,19 @@ When combined with localtunnel, things get interesting. Startup your yeti server

You can then visit that URL on your mobile (or any other) device and have it run new tests.

You probably shouldn't use this. Yet.
-------------------------------------

Yeti is limited:
Caveats
-------

- Requires Mac OS X.
- Assumes you're testing the local copy of the [yui3][] project.
Yeti requires Mac OS X.

In the future, Yeti will probably meet your needs better. Right now, it's pretty handy for [YUI][yui3] developers. :)
You must start Yeti in server mode in the directory you'll be serving tests from. For security reasons, Yeti will reject requests that try to access files outside of the directory you start Yeti in.

Installation
------------

This is experimental software. Use at your own risk.

You should only do this on Mac OS X. Yeti won't work on other platforms (yet).
You should only do this on Mac OS X. Yeti is untested on other platforms.

If you have [npm][] installed, this will be easy.

Expand All @@ -109,10 +108,36 @@ Installing [localtunnel][] helps proxy Yeti outside of your firewall. It's avail

$ gem install localtunnel

Bugs & Feedback
---------------

Open a ticket using [GitHub Issues][issues] to report bugs or feature requests.

Yeti is an experimental project brought to you by a [YUI][] team member. As such, it doesn't receive any official level of support from YUI.

Testing
-------

Yeti uses [Vows][] for testing its built-in server. After installing Vows, you may run the `vows` command to run all suites. See the [Vows website][Vows] for information on installing and running Vows.

License
-------

Yeti is offered under the terms of the BSD license. See the LICENSE file or the [YUI license][license] for license text and copyright information.

Contribute
----------

Your contributions are welcome! Please review the [YUI contributor guide][CLA] before contributing. If you haven't contributed to a [YUI project][YUI] before, you'll need to review and sign the [YUI CLA][CLA] before I can accept your pull request.

[jspec]: http://github.com/visionmedia/jspec
[yui3]: http://github.com/yui/yui3
[localtunnel]: http://localtunnel.com/
[homebrew]: http://github.com/mxcl/homebrew
[node]: http://nodejs.org/
[npm]: http://npmjs.org/

[issues]: http://github.com/reid/yeti/issues
[YUI]: http://yuilibrary.com/
[Vows]: http://vowsjs.org/
[license]: http://developer.yahoo.com/yui/license.html
[CLA]: http://developer.yahoo.com/yui/community/#cla

0 comments on commit 7304e7d

Please sign in to comment.