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

Update README.md #9

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #9

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
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,12 @@
- [IServerInterceptor](#iserverinterceptor)
- [IClientInterceptor](#iclientinterceptor)
- [Related](#related)
- [Release new version](#release-new-version)
- [Maintainers](#maintainers)

## About
`grpc-timeouts` is a small library that makes it easy to add customizable timeouts to your services. The library implements a circuit breaker pattern, which means that if the request exceeds the deadline, no further requests will be sent. If the deadline for a received request has expired, the request will not be processed and service instantly answers with code 4 (Deadline exceeded).

## Release New version

For new version use https://github.com/semantic-release/semantic-release description.
We must set commit message fix(pencil): New feature in release

## Installation

`npm i @byndyusoft/grpc-timeouts`
Expand Down Expand Up @@ -107,5 +103,10 @@ A function that can be used as client interceptor.
## Related
[grpc-host-builder](https://www.npmjs.com/package/grpc-host-builder)

## Release new version
For new version use https://github.com/semantic-release/semantic-release description.

We must set commit message `fix(pencil): New feature in release`

## Maintainers
@Byndyusoft/owners: https://github.com/orgs/Byndyusoft/teams/owners, [email protected]