I noticed that there is Antora for making the SDK docs. I added a new document there in my PR -https://github.com/aerogear/aerogear-xamarin-sdk/pull/53

README file in the repo is not actual and links are dead. How should we update README, should we move everything there and just reference to the documentation in README? 

Because Antora has some predefined file structure, it's not possible (I didn't find any way) to have links that work together with Asciidoc displaying in Github.
--