Merge pull request #55 from KacperFKorban/readme-test

Change README to a symlink

README.md

@@ -0,0 +1 @@
+./docs/_docs/index.md

docs/_docs/index.md

@@ -1,3 +1,5 @@
+[![guinep Scala version support](https://index.scala-lang.org/kacperfkorban/guinep/guinep/latest.svg)](https://index.scala-lang.org/kacperfkorban/guinep/guinep)
+
 # GUInep
 
 > Guinep are small tropical fruits from the Caribbean and Central/Southern America. They are described to taste like a cross between Lime and Lychee. 
@@ -54,4 +56,18 @@ def run =
 
 ## Demo
 
-![GUInep_classes_demo](https://github.com/KacperFKorban/GUInep/assets/39772805/556b6c1b-ea72-4089-8cbd-16f680484177)
+<img src="https://github.com/KacperFKorban/GUInep/assets/39772805/556b6c1b-ea72-4089-8cbd-16f680484177" style="max-width: 100%; max-height: 100%">
+
+## Current limitations
+
+Currently GUInep doesn't support:
+- Functions with multiple parameter lists (and by extension - extension methods) - https://github.com/KacperFKorban/GUInep/issues/33
+- Fancier GADTs with unobvious inheritance, type bounds and variance - https://github.com/KacperFKorban/GUInep/issues/30
+- Union and intersection types - https://github.com/KacperFKorban/GUInep/issues/44
+- Opaque types - https://github.com/KacperFKorban/GUInep/issues/49
+
+## Contributing
+
+If you have any ideas on how to improve GUInep, feel free to open an issue.
+
+All bug reports and feature requests are highly appreciated.