README.md in knapsack_pro-0.12.0 vs README.md in knapsack_pro-0.13.0
- old
+ new
@@ -13,11 +13,11 @@
* [Cucumber](https://cucumber.io)
* [Minitest](http://docs.seattlerb.org/minitest/)
* [Spinach](https://github.com/codegram/spinach)
* [Turnip](https://github.com/jnicklas/turnip)
-__Would you like to try knapsack_pro gem?__ You can [get API token here](http://knapsackpro.com).
+__Would you like to try knapsack_pro gem?__ You can [get API token here](http://knapsackpro.com?utm_source=github&utm_medium=readme&utm_campaign=knapsack_pro-ruby_gem&utm_content=get_api_token).
## Is knapsack_pro gem free?
* If your __project is open source__ then you can use Knapsack Pro for free. Just add a link back to the page http://knapsackpro.com and please let me know via email (arturtrzop@gmail.com). I will mark your account on KnapsackPro.com as open source.
@@ -107,19 +107,27 @@
end
```
And then execute:
- $ bundle
+ $ bundle install
Add this lines at the bottom of `Rakefile` if your project has it:
```ruby
KnapsackPro.load_tasks if defined?(KnapsackPro)
```
+Run installer to get started. It will ask you a few questions and generate instruction steps for your project.
+
+ $ bundle exec rake knapsack_pro:install
+
+You can read next section only if you want to better understand optional gem configuration and features.
+
+## How to set up
+
If you are using [VCR gem](https://github.com/vcr/vcr) then add Knapsack Pro API subdomain to [ignore hosts](https://www.relishapp.com/vcr/vcr/v/2-9-3/docs/configuration/ignore-request):
```ruby
# spec/spec_helper.rb or wherever is your VCR configuration
@@ -128,12 +136,10 @@
end
WebMock.disable_net_connect!(:allow => 'api.knapsackpro.com') if defined?(WebMock)
```
-## How to set up
-
### Usage (How to set up 1 of 3)
__Tip:__ You can find here example of rails app with already configured knapsack_pro.
https://github.com/KnapsackPro/rails-app-with-knapsack_pro
@@ -182,11 +188,11 @@
```ruby
require 'knapsack_pro'
# CUSTOM_CONFIG_GOES_HERE
-KnapsackPro::Adapters::CucumberAdapter.bind
+KnapsackPro::Adapters::SpinachAdapter.bind
```
#### Custom configuration
You can change default Knapsack Pro configuration for RSpec, Cucumber, Minitest or Spinach tests. Here are examples what you can do. Put below configuration instead of `CUSTOM_CONFIG_GOES_HERE`.
@@ -425,11 +431,11 @@
Please remember to add additional containers for your project in CircleCI settings.
#### Info for Travis users
-You can parallel your builds across virtual machines with [travis matrix feature](http://docs.travis-ci.com/user/speeding-up-the-build/#Parallelizing-your-builds-across-virtual-machines). Edit `.travis.yml`
+You can parallelize your builds across virtual machines with [travis matrix feature](http://docs.travis-ci.com/user/speeding-up-the-build/#Parallelizing-your-builds-across-virtual-machines). Edit `.travis.yml`
```yaml
script:
# Step for RSpec
- "bundle exec rake knapsack_pro:rspec"
@@ -552,10 +558,10 @@
$ bundle exec rspec spec
## Contributing
-1. Fork it ( https://github.com/ArturT/knapsack/fork )
+1. Fork it ( https://github.com/KnapsackPro/knapsack_pro-ruby )
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`)
5. You can create example tests in related repository with example of [rails application and knapsack_pro gem usage](https://github.com/KnapsackPro/rails-app-with-knapsack_pro).
6. Create a new Pull Request