From c66221fc4646e45d665c6755877ab333e3dcf9ba Mon Sep 17 00:00:00 2001 From: Xavier Drdak <1198051+xdrdak@users.noreply.github.com> Date: Fri, 29 Apr 2022 17:32:30 -0400 Subject: [PATCH] chore: update readme to include links to openapi docs (#338) --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 819ddcc67..f87f72b88 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,9 @@ + [![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors-) + ## Description @@ -34,8 +36,13 @@ Ensure the following have been installed on your system: ## Getting Started -You can get started building immediately!
-See Zapper Studio docs for more details +You can get started building immediately! + +OpenAPI docs for studio is available on localhost:5001/docs. Which will give +you a rough overview of all exposed endpoints you can test out. + +If you wish to know how to integrate your application, please check out +Zapper Studio docs for more details. ### Installation