Update README.md

This commit is contained in:
Antoine Gersant 2019-04-09 23:51:47 -07:00 committed by GitHub
parent c3a2ecd7fc
commit f3e48b8507
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -100,6 +100,7 @@ When you install Polaris, it comes with a web interface which can be accessed us
# Documentation
The Polaris server API is documented [here](https://agersant.github.io/polaris/swagger/). Please note that this Swagger page does not point to any live Polaris server so the `Try it out` buttons are not expected to work.
The Polaris server API is documented [here](https://agersant.github.io/polaris/swagger/). Please note that this Swagger page does not point to a live Polaris server so the `Try it out` buttons are not expected to work.
Every installation of Polaris also distributes this documentation, with the ability to use the `Try it out` buttons. To access it, simply open http://localhost:5050/swagger/ in your browser on the machine running Polaris.
Feel free to open Github issues (or Pull Requests) if clarifications are needed.