diff --git a/README.md b/README.md index b141fbb..f3884f5 100644 --- a/README.md +++ b/README.md @@ -1 +1,12 @@ -protobuf definition files for git repositories +# protobuf definition files for git repositories + +# requires autogenpb & go-mod-clean + +* go-clone go.wit.com/apps/autogenpb +* you might also need: go-clone go.wit.com/apps/utils/go-mod-clean + +# Notes/TODO + +* all autogen files are stored as git metadata this includes the go.mod and go.sum files +* this is done to keep the git commit log as clean as possible +* metadata can be manipulated using go-mod-clean