chore: adds generateed code documentation

cludden · Oct 22, 2023 · 51b472a · 51b472a
1 parent 35b5372
commit 51b472a
Show file tree

Hide file tree

Showing 2 changed files with 1,925 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -17,6 +17,7 @@ A protoc plugin for generating typed Temporal clients and workers in Go from pro
 		- [ID Expressions](#id-expressions)
 	- [CLI](#cli)
 	- [Test Client](#test-client)
+	- [Documentation](#documentation)
 	- [License](#license)
 
 ## How it works
@@ -628,6 +629,10 @@ The generated code includes resources that are compatible with the Temporal Go S
 
 **_Note:_** that all queries, signals, and udpates must be called via the test environment's `RegisterDelayedCallback` method prior to invoking the test client's synchronous `<Workflow>` method or an asynchronous workflow run's `Get` method.
 
+## Documentation
+
+- [Generated code reference](./docs/generated.md)
+
 ## License
 Licensed under the [MIT License](LICENSE.md)  
 Copyright for portions of project cludden/protoc-gen-go-temporal are held by Chad Retz, 2021 as part of project cretz/temporal-sdk-go-advanced. All other copyright for project cludden/protoc-gen-go-temporal are held by Chris Ludden, 2023.