Add documentation for the tests_from_xcresult action

README.md

@@ -40,6 +40,7 @@ _read the documentation on each action by clicking on the action name_
 | [`test_options_from_testplan`](docs/feature_details/test_options_from_testplan.md) | returns the tests and test code coverage configuration for a given testplan | ios, mac |
 | [`testplans_from_scheme`](docs/feature_details/testplans_from_scheme.md) | returns the testplans that an Xcode Scheme references | ios, mac |
 | [`tests_from_junit`](docs/feature_details/tests_from_junit.md) | returns the passing and failing tests in a Junit test report | ios, mac |
+| [`tests_from_xcresult`](docs/feature_details/tests_from_xcresult.md) | returns the passing and failing tests in a xcresult bundle | ios, mac |
 | [`tests_from_xctestrun`](docs/feature_details/tests_from_xctestrun.md) | returns a list of tests for each test target in a `xctestrun` file  | ios, mac |
 | [`collate_junit_reports`](docs/feature_details/collate_junit_reports.md) | combines multiple Junit test reports into one report | ios, mac |
 | [`collate_html_reports`](docs/feature_details/collate_html_reports.md) | combines multiple HTML test reports into one report | ios, mac |

docs/feature_details/test_options_from_testplan.md

@@ -17,7 +17,7 @@ UI.important(
 test_options = test_options_from_testplan(
   testplan: 'AtomicBoy/AtomicBoy_2.xctestplan'
 )
-UI.message("The AtomicBoy_2 testplan has the following tests: #{test_options[:only_testing'}")
+UI.message("The AtomicBoy_2 testplan has the following tests: #{test_options[:only_testing]}")
 
 ```
 <!-- test_options_from_testplan examples: end -->

docs/feature_details/tests_from_junit.md

@@ -1,7 +1,7 @@
 
 # ☑️  tests_from_junit
 
-Performing analysis on a test report file? Get the lists of failing and passing tests using this action.
+Performing analysis on a test report file? Get the failing and passing tests using this action.
 
 <center><img src="./images/tests_from_junit.png" alt="tests from junit" /></center>
 

docs/feature_details/tests_from_xcresult.md

@@ -0,0 +1,36 @@
+
+
+# ☑️  tests_from_xcresult
+
+Performing analysis on an `.xcresult` bundle? Get the failing and passing tests using this action.
+
+> **Note**: I'm making this new action available to Supporters first to show them appreciation. I'll open it up to everyone else on September 1st, 2020.
+>
+> Interested in joining? Click [here ♥️](https://github.com/sponsors/lyndsey-ferguson) and select a tier that gives you early access to new features.
+>
+> **Bonus**: if your organization (👨‍👩‍👧‍) becomes a Sponsor, every member of that org gets that same early access!
+
+## Example
+
+<!-- tests_from_xcresult examples: begin -->
+
+```ruby
+
+UI.important(
+  'example: ' \
+  'get the failed and passing tests from a xcresult bundle'
+)
+result = tests_from_xcresult(xcresult: './spec/fixtures/AtomicBoy.xcresult')
+UI.message("Passing tests: #{result[:passing]}")
+UI.message("Failed tests: #{result[:failed]}")
+
+```
+<!-- tests_from_xcresult examples: end -->
+
+## Parameters
+
+<!-- tests_from_xcresult parameters: begin -->
+|Parameter|Description|Default Value|
+|:-|:-|-:|
+|xcresult|The path to the xcresult bundle to retrieve the tests from||
+<!-- tests_from_xcresult parameters: end -->