Skip to content

Commit

Permalink
added badges to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Dan-Tan committed Aug 5, 2023
1 parent c519079 commit fb24745
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Welcome to Riot-cpp

[![Build Status]](https://github.com/Dan-Tan/riot-cpp/actions/workflows/build.yml/badge.svg?event=push) [![Documentation](https://dan-tan.github.io/riot-cpp/)](https://github.com/Dan-Tan/riot-cpp/actions/workflows/ci.yaml/badge.svg?event=push)

Simple Api client for the Riot Games Resful API implemented in C++ 20.

This library implements rate limiting to prevent api key blacklisting from exceeding Riot's rate limits. The library handles server response error's and will retry when a successful request is possible (429, 500, 503 errors). The client contains a logging class to help with debugging dependent code as well as providing information of the running of the client. Riot-cpp will adapt to the specific api key's rate limits after the first request and try to recover from errors.
Expand Down

0 comments on commit fb24745

Please sign in to comment.