From 83f5a661a2c25fa4cb27262480ea984b1c23509b Mon Sep 17 00:00:00 2001 From: robinbraemer Date: Mon, 10 Aug 2020 16:25:57 +0200 Subject: [PATCH] update README.md --- README.md | 13 +++++++------ pkg/proxy/plugin.go | 2 +- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0b8bbcb5..4aefdf28 100644 --- a/README.md +++ b/README.md @@ -142,14 +142,15 @@ more things planned (e.g. command system, more events, stability etc.). ### Native Go You can import Gate as a Go module and use it like a framework -in your own external projects. +in your own project. -Go get it into your project -- `go get -u go.minekube.com/gate` +Go get it into your project: +``` +go get -u go.minekube.com/gate +``` - -create a `proxy.New(...)`, register servers and event subscribers and start -`proxy.Listen(...)` for connections. +**Refer to [plugin.go](https://github.com/minekube/gate/blob/master/pkg/proxy/plugin.go) +for detailed information!** > TODO: code examples diff --git a/pkg/proxy/plugin.go b/pkg/proxy/plugin.go index 36b52980..777ed94f 100644 --- a/pkg/proxy/plugin.go +++ b/pkg/proxy/plugin.go @@ -21,7 +21,7 @@ var Plugins []Plugin // // Native Go: // -// - Create your own Go project/module and `go get "go.minekube.com/gate"` +// - Create your own Go project/module and `go get "go.minekube.com/gate"` // - Within you main function // - Add your "plugin's" Hook to the Plugins // - And call cmd/gate.Execute (blocking your main until shutdown).