I realize this is happening with a lot of extensions but I find it a little unfortunate.
People who visit GitHub see the Readme. People who visit docs.typo3 see the rendered documentation in Documentation. Which is up-to-date? Which should people contribute to.
What some other extensions do, is just provide a short Readme and then link to the generated documentation on docs.typo3.org.
I realize this is happening with a lot of extensions but I find it a little unfortunate.
People who visit GitHub see the Readme. People who visit docs.typo3 see the rendered documentation in
Documentation
. Which is up-to-date? Which should people contribute to.What some other extensions do, is just provide a short Readme and then link to the generated documentation on docs.typo3.org.
You can - of course - do whatever you want.