From 9a2b10476c64c899dcc44187197009b23e4acdff Mon Sep 17 00:00:00 2001 From: Daniel Valdivia Date: Mon, 6 Apr 2020 12:07:40 -0700 Subject: [PATCH] Updated README.md (#33) --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a92603163..ede866d94 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # MCS Minio Console Service -This is a REST portal server created using [go-swagger](https://github.com/go-swagger/go-swagger) +A graphical user interface for [MinIO](https://github.com/minio/minio) ## Setup @@ -57,13 +57,15 @@ To run the server: export MCS_ACCESS_KEY=mcs export MCS_SECRET_KEY=YOURMCSSECRET export MCS_MINIO_SERVER=http://localhost:9000 -./mcs +./mcs server ``` You can verify that the apis work by doing the request on `localhost:9090/api/v1/...` # Development +This is a REST portal server created using [go-swagger](https://github.com/go-swagger/go-swagger) + The API handlers are created using a YAML definition located in `swagger.YAML`. To add new api, the YAML file needs to be updated with all the desired apis using the [Swagger Basic Structure](https://swagger.io/docs/specification/2-0/basic-structure/), this includes paths, parameters, definitions, tags, etc.