Skip to content

Commit

Permalink
Merge pull request #457 from cucumber/feature/fix-docs-api
Browse files Browse the repository at this point in the history
Fix docs for developers
  • Loading branch information
maxmeyer authored Jul 20, 2017
2 parents e26161f + 853c328 commit 37935a0
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,12 @@ gem install aruba

### As a user getting started with "aruba"

Our most current documentation to get started with `aruba` can be found on [![See our documentation on Cucumber Pro](https://github.com/cucumber-ltd/brand/raw/master/images/png/notm/cucumber-pro-black/cucumber-pro-black-32.png)](https://app.cucumber.pro/projects/aruba). It is generated from our feature files describing the use of `aruba`.
Our most current documentation to get started with `aruba` as a user can be found on [![See our documentation on Cucumber Pro](https://github.com/cucumber-ltd/brand/raw/master/images/png/notm/cucumber-pro-black/cucumber-pro-black-32.png)](https://app.cucumber.pro/projects/aruba). It is generated from our feature files describing the use of `aruba`.

### As a developer getting started with "aruba"

A full documentation of the API for developers can be found on
[RubyDoc](http://www.rubydoc.info/github/cucumber/aruba/master/frames).

## Support

Expand Down
6 changes: 5 additions & 1 deletion features/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
[![Code Climate](https://codeclimate.com/github/cucumber/aruba.svg)](https://codeclimate.com/github/cucumber/aruba)
[![Support](https://img.shields.io/badge/cucumber-support-orange.svg)](https://cucumber.io/support)

**This is the [latest](https://github.com/cucumber/aruba/blob/master/features/README.md) version of our README.md. If you want to see the one of the last released version of "aruba", please have a look at this [one](https://github.com/cucumber/aruba/blob/still/features/README.md).**
**This is the [latest](https://github.com/cucumber/aruba/blob/master/features/README.md) version of our README.md.**

<!-- **If you want to see the one of the last released version of "aruba", please have a look at this [one](https://github.com/cucumber/aruba/blob/still/features/README.md).** -->

`aruba` is an extension for popular TDD and BDD frameworks like "Cucumber", "RSpec" and "Minitest" to make testing of commandline applications meaningful, easy and fun.

Expand Down Expand Up @@ -172,6 +174,8 @@ for the most up to date documentation.
bundle exec ruby -I lib:test test/use_aruba_with_minitest.rb
~~~

## Development

A full documentation of the API can be found
[here](http://www.rubydoc.info/github/cucumber/aruba/master/frames).

Expand Down

0 comments on commit 37935a0

Please sign in to comment.