From cb04e0e2455aebb79ff85d5b66769db4ba7d8fd1 Mon Sep 17 00:00:00 2001 From: Gert van der Spoel Date: Sat, 9 Jul 2022 13:23:05 +0300 Subject: [PATCH] Update README.md Some small textual corrections/adjustments. --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index eaddf5b4..0dfb8ef9 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,9 @@ [![Gem Version](https://badge.fury.io/rb/ruby_raider.svg)](https://badge.fury.io/rb/ruby_raider) [![Rubocop](https://github.com/RubyRaider/ruby_raider/actions/workflows/rspec.yml/badge.svg)](https://github.com/RubyRaider/ruby_raider/actions/workflows/rspec.yml) -This is a gem to make setup and start of UI automation projects easier -You can find more information and updates on releases in : https://ruby-raider.com/ +This is a gem to make setup and start of UI automation projects easier. + +You can find more information and updates on releases in : [https://ruby-raider.com/](https://ruby-raider.com/) Just do: @@ -14,11 +15,11 @@ then do: **raider new [name_of_project]** -and you will have a new project in the folder you are in +and you will have a new project in the folder you are in. Currently we support: -* Gerating a framework with Cucumber and Selenium +* Generating a framework with Cucumber and Selenium * Generating a framework with Rspec and Selenium @@ -30,9 +31,9 @@ Currently we support: * Generating a framework with Cucumber and Appium for IOS -In order to run the appium tests, download the example [app](https://github.com/cloudgrey-io/the-app/releases/tag/v1.10.0) +In order to run the Appium tests, download the example [app](https://github.com/cloudgrey-io/the-app/releases/tag/v1.10.0). -This works in all the platforms (Tested on Mac OS, Linux and Windows) +This works in all the platforms (Tested on Mac OS, Linux and Windows). **Ruby raider provides the following list of commands** ``` @@ -41,7 +42,7 @@ Commands: raider feature [FEATURE_NAME] # Creates a new feature - raider help [COMMAND] # Describe available commands or one specific command + raider help [COMMAND] # Describes available commands or one specific command raider helper [HELPER_NAME] # Creates a new helper @@ -51,9 +52,9 @@ Commands: raider path [PATH] # Sets the default path for scaffolding - raider raid # It runs all the tests in a project + raider raid # Runs all the tests in a project - raider scaffold [SCAFFOLD_NAME] # It generates everything needed to start automating + raider scaffold [SCAFFOLD_NAME] # Generates everything needed to start automating raider spec [SPEC_NAME] # Creates a new spec @@ -71,4 +72,4 @@ raider path [PATH_NAME] --spec or -s raider path [PATH_NAME] --helper or -h ``` -If you don't specify an option path will assume you want to change the default path for pages +If you don't specify an option, path will assume you want to change the default path for pages.