[Proposal] Improve the docs

[maheshj01]

This issue tracks a request to improve the documentation for this package. This issue will be marked as closed when all the below conditions are met.

• [x] Publish docs using docs.page
• [ ] Include examples for different use cases.
• [ ] Keep readme.md clear and concise.
• [x] Add a link to detailed documentation in the readme.md.
• [ ] Update the medium blogpost as per the current state of the package.
• [x] Add a showcase section showing the apps that use NavbarRouter.
• [ ] Add a link to edit the docs