Merge pull request #355 from paveljandejsek/knownIssuesMd

Added known issues section to markdown docs.

README.md

@@ -47,6 +47,9 @@ Contributors guide can be found in [CONTRIBUTING.md](CONTRIBUTING.md)
 
 ## Best practices
 - [Best practices](jbehave-support-core/docs/Best-practices.md)
+
+## Known issues
+- [Known issues](jbehave-support-core/docs/Known-issues.md)
 
 ## Simple use case - Web testing
 

jbehave-support-core/README.md

@@ -4,6 +4,7 @@ Core jBehave support.
 - [Expression commands](docs/Expression-commands.md)
 - [Test context](docs/Test-context.md)
 - [Best practices](docs/Best-practices.md)
+- [Known issues](docs/Known-issues.md)
 - Steps
     - [Web testing steps](docs/Web-testing.md)
     - [REST API steps](docs/Rest-api.md)  

jbehave-support-core/docs/Known-issues.md

@@ -0,0 +1,18 @@
+[Contents](../README.md)
+## Known issues
+
+- [UI testing](#ui-testing)
+- [Reports](#reports)
+
+### UI testing
+#### Wrong element selected when using JavaScript frameworks that change DOM structures often
+When testing UIs written in JS frameworks changing DOM structure on the fly (React, Angular, etc.) 
+you can sometimes encounter problems with selectors selecting different elements than expected (due to not all elements being present in DOM tree at the time when the selecting happens).
+
+This is sadly a Selenium related issue which we cannot fix. 
+In case you encounter this behavior then a solution for this is to introduce some static wait before running the selector.
+
+### Reports
+#### Broken Reports when using JBehave parametrised test with Examples keyword
+Our reports are currently not being generated in a way that supports the `Examples` keyword.  
+See [#80](https://github.com/EmbedITCZ/jbehave-support/issues/80) for more details.