towk/configurator
1
0
Fork 0
mirror of https://github.com/davidallendj/configurator.git synced 2025-12-20 11:37:00 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated README.md

Browse source
This commit is contained in:
David Allen 2024-06-26 10:11:16 -06:00
parent fad5dcb8a9
commit 2a2185ded0
No known key found for this signature in database
GPG key ID: 717C593FF60A2ACC
1 changed files with 2 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -71,11 +71,7 @@ func (g *MyGenerator) GetName() string {
return "my-generator" return "my-generator"
} }
func (g *MyGenerator) GetGroups() []string { func (g *MyGenerator) Generate(config *configurator.Config, opts ...util.Option) (map[string][]byte, error) {
return []string{ "my-generator" }
}
func (g *MyGenerator) Generate(config *configurator.Config, opts ...util.Option) ([]byte, error) {
// do config generation stuff here... // do config generation stuff here...
var ( var (
params = generator.GetParams(opts...) params = generator.GetParams(opts...)
@ -103,7 +99,7 @@ Finally, build the plugin and put it somewhere specified by `plugins` in your co
go build -buildmode=plugin -o lib/mygenerator.so path/to/mygenerator.go go build -buildmode=plugin -o lib/mygenerator.so path/to/mygenerator.go
``` ```
Now your plugin should be available to use with the `configurator` main driver. Now your plugin should be available to use with the `configurator` main driver. If you get an error about not loading the correct symbol type, make sure that you generator function definitions match the `Generator` interface exactly.
## Configuration ## Configuration