Skip to content

Commit fe7ebd5

Browse files
committed
Add basic library description to README.
1 parent 433bd8b commit fe7ebd5

File tree

1 file changed

+4
-14
lines changed

1 file changed

+4
-14
lines changed

README.md

+4-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,7 @@
1-
## My Project
1+
## backOffAlgorthm Library
22

3-
TODO: Fill this README out!
3+
This repository contains the backoffAlgorithm library, a utility library to calculate interval period for network operation retries (like failed network connection with server) using exponential back-off with jitter algorithm. The backoffAlgorithm library is distributed under the [MIT Open Source License](LICENSE).
44

5-
Be sure to:
6-
7-
* Change the title in this README
8-
* Edit your repository description on GitHub
9-
10-
## Security
11-
12-
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
13-
14-
## License
15-
16-
This library is licensed under the MIT-0 License. See the LICENSE file.
5+
This library supports the "Full Jitter" algorithm for exponential back-off with jitter.
6+
More information about the algorithm can be seen in the [Exponential Backoff and Jitter](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/) AWS blog.
177

0 commit comments

Comments
 (0)