Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update README #24

Merged
merged 1 commit into from
Jul 7, 2024
Merged

update README #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
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.
Loading