Merge pull request #100 from hrcorval/release_3.0.0

additional formatting improvements in documentation

README.md

@@ -84,12 +84,10 @@ Examples:
 
 * BehaveX is currently implemented on top of Behave **v1.2.6**, and not all Behave arguments are yet supported.
 * The parallel execution implementation is based on concurrent Behave processes. Therefore, any code in the **before_all** and **after_all** hooks in the **environment.py** module will be executed in each parallel process. The same applies to the **before_feature** and **after_feature** hooks when the parallel execution is set by scenario.
-* The library is provided as is, and no tests have been implemented for the framework yet (initial versions had tests, but they were deprecated). Any contributions to testing would be greatly appreciated.
 
 ### Additional Comments
 
-* The **stop** argument does not work when performing parallel test executions.
-* The JUnit reports have been replaced by the ones generated by the test wrapper, just to support muting tests
+* The JUnit reports have been replaced by the ones generated by the test wrapper, just to support muting tests scenarios on build servers
 
 ## Supported Behave arguments
 
@@ -113,18 +111,20 @@ Examples:
 * tags
 * tags-help
 
-It is important to mention that some arguments do not apply when executing tests with more than one parallel process, such as **stop**, **color**, etc.
+IMPORTANT: It worth to mention that some arguments do not apply when executing tests with more than one parallel process, such as **stop**, **color**, etc.
+
 Also, there might be more arguments that can be supported, it is just a matter of extending the wrapper implementation to use these.
 
-## Additional BehaveX arguments
-* output_folder
+## Specific arguments from BehaveX
+
+* >output_folder
   * Specifies the output folder where execution reports will be generated (JUnit, HTML and JSon)
-* dry-run
+* >dry-run
   * Overwrites the existing Behave dry-run implementation
   * Performs a dry-run by listing the scenarios as part of the output reports
-* parallel_processes
+* >parallel_processes
   * Specifies the number of parallel Behave processes
-* parallel_scheme
+* >parallel_scheme
   * Performs the parallel test execution by [scenario|feature]
 
 ## Parallel test executions

docs/README.md

@@ -84,12 +84,10 @@ Examples:
 
 * BehaveX is currently implemented on top of Behave **v1.2.6**, and not all Behave arguments are yet supported.
 * The parallel execution implementation is based on concurrent Behave processes. Therefore, any code in the **before_all** and **after_all** hooks in the **environment.py** module will be executed in each parallel process. The same applies to the **before_feature** and **after_feature** hooks when the parallel execution is set by scenario.
-* The library is provided as is, and no tests have been implemented for the framework yet (initial versions had tests, but they were deprecated). Any contributions to testing would be greatly appreciated.
 
 ### Additional Comments
 
-* The **stop** argument does not work when performing parallel test executions.
-* The JUnit reports have been replaced by the ones generated by the test wrapper, just to support muting tests
+* The JUnit reports have been replaced by the ones generated by the test wrapper, just to support muting tests scenarios on build servers
 
 ## Supported Behave arguments
 
@@ -113,18 +111,20 @@ Examples:
 * tags
 * tags-help
 
-It is important to mention that some arguments do not apply when executing tests with more than one parallel process, such as **stop**, **color**, etc.
+IMPORTANT: It worth to mention that some arguments do not apply when executing tests with more than one parallel process, such as **stop**, **color**, etc.
+
 Also, there might be more arguments that can be supported, it is just a matter of extending the wrapper implementation to use these.
 
-## Additional BehaveX arguments
-* output_folder
+## Specific arguments from BehaveX
+
+* >output_folder
   * Specifies the output folder where execution reports will be generated (JUnit, HTML and JSon)
-* dry-run
+* >dry-run
   * Overwrites the existing Behave dry-run implementation
   * Performs a dry-run by listing the scenarios as part of the output reports
-* parallel_processes
+* >parallel_processes
   * Specifies the number of parallel Behave processes
-* parallel_scheme
+* >parallel_scheme
   * Performs the parallel test execution by [scenario|feature]
 
 ## Parallel test executions