diff --git a/README.md b/README.md index cfe89ed..14fefa5 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,28 @@ https://competitive-coding-api.herokuapp.com/api/ ## Request Format https://competitive-coding-api.herokuapp.com/api/{platform_name}/{user_name} -### Example +### Example URL https://competitive-coding-api.herokuapp.com/api/codechef/abhijeet_ar +### Example Badges +[Shields](https://shields.io/) can create dynamically updated badges from a JSON source such as this API. More configuration options are also available in their section on [dynamic badges](https://shields.io/#dynamic-badge). + +Replace `` with your username on that platform. + +#### abhijeet_ar's profile on Codeforces +`https://img.shields.io/badge/dynamic/json?&color=1f8acb&logo=codeforces&label=Codeforces&url=https://competitive-coding-api.herokuapp.com/api/codeforces/&query=%24.&prefix=&style=for-the-badge&cacheSeconds=86400` + +Suggested use, +* `` = `rating` +* `` = `Rating%20` + +#### radix28_numb's profile on CodeChef +`https://img.shields.io/badge/dynamic/json?label=CodeChef&query=%24.global_rank&url=https://competitive-coding-api.herokuapp.com/api/codechef/&prefix=&logo=codechef&logoColor=f5f5dc&labelColor=7b5e47&style=for-the-badge&cacheSeconds=86400` + +Suggested use, +* `` = `global_rank`, `country_rank` or `rating` +* `` = `Rank%20`, country abbreviation (e.g., `US%20%23`) or `Rating%20` + ### Pro Tip 💡 Use this [JSON Formatter Chrome Extension](https://chrome.google.com/webstore/detail/json-formatter/bcjindcccaagfpapjjmafapmmgkkhgoa?hl=en) to view in a structured format.