README.md in specserv-0.0.4 vs README.md in specserv-0.0.5

- old
+ new

@@ -1,33 +1,35 @@ SpecServ ======== -Serve HTML test results from any directory to a web browser via HTTP. +Serves dynamically updated RSpec results from any directory as HTML -Currently uses RSpec, but aims to become platform-agnostic. +## Installation ## -## Installation +Just run: -Add this line to your application's Gemfile: + $ gem install specserv -```ruby -gem 'specserv' -``` +## Usage ## -And then execute: +`cd` into your spec directory, run `specserv` and make a note of the port. - $ bundle +Then visit http://localhost:port/relative/path/to/spec_file (without the .rb extension). -Or install it yourself as: +## Dependencies ## - $ gem install specserv +Requires RSpec and Sinatra -## Usage +## Roadmap ## -cd into any directory and run ```specserv``` -visit http://localhost:port/[spec_file_name_without_extension] +- Become platform-agnostic, not RSpec specific. +- Overhaul aesthetics +- Navigable test-case index pages +- Support for custom formatters +- Authentication for sensitive results +- Make Rack compatible for use with any webserver -## Contributing +## Contributing ## 1. Fork it ( https://github.com/andybrice/specserv/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) \ No newline at end of file