-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #24 from gripmock/add-godocs
update README
- Loading branch information
Showing
1 changed file
with
11 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,11 @@ | ||
# stuber | ||
# stuber | ||
|
||
`stuber` is a Go package that uses the `github.com/bavix/gripmock` package to find stubs for gRPC requests. | ||
|
||
The `stuber` package provides a `Budgerigar` struct that contains a searcher and toggles. The searcher is a map that stores and retrieves used stubs by their UUID. The toggles are flags that control the behavior of the `Budgerigar`. | ||
|
||
The `Budgerigar` struct has methods to search for and return stubs based on a given query. It also has a method to add stubs to the searcher. | ||
|
||
The `stuber` package is designed to be used in conjunction with the `github.com/bavix/gripmock` package to create a mock gRPC server. | ||
|
||
The `stuber` package is designed to be used as a dependency in other Go projects. It is released under the MIT license. |