From bdbe2a8ed02b42e05287c491ca23a5ed0132e0c1 Mon Sep 17 00:00:00 2001 From: "A.Unger" Date: Tue, 17 Dec 2019 14:47:20 +0100 Subject: [PATCH] update readme with usage --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/README.md b/README.md index 7b7919b03..3c30cb7f1 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,49 @@ make generate build ./bin/ocis -h ``` +## Getting Started + +Included with the ocis binary is embedded a go-micro runtime that is in charge of starting services as a fork of the master process. This provides complete control over the services. Ocis extensions can be added as part of this runtime. + +```sh +> ./bin/ocis micro +``` + +This will currently boot: + +```sh +go.micro +go.micro.api +go.micro.bot +go.micro.broker +go.micro.debug +go.micro.http.broker +go.micro.monitor +go.micro.network +go.micro.proxy +go.micro.registry +go.micro.router +go.micro.runtime +go.micro.store +go.micro.tunnel +go.micro.web +``` + +Further ocis extensions can be added to the runtime via the ocis command like: + +```sh +./bin/ocis hello +``` + +Which whill register: + +```sh +go.micro.web.hello +go.micro.api.hello +``` + +To the list of available services. + ## Security If you find a security issue please contact security@owncloud.com first.