From 68732c5118441f15020200505a67025777066021 Mon Sep 17 00:00:00 2001
From: Matteo Ciapparelli <ciapparellimatteo@gmail.com>
Date: Sun, 16 Feb 2025 22:07:36 +0100
Subject: [PATCH] Update README with usage examples and badges

---
 README.md | 48 +++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 41 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 89e374e..1ec8f6b 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,47 @@
-# github-bubble-chart
+# GitHub Bubble Chart
 
-Insert a bubble chart into your GitHub profile readme. Which makes for great [github profile readme](https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme).
+[![CI](https://github.com/teociaps/github-bubble-chart/actions/workflows/ci.yml/badge.svg)](https://github.com/teociaps/github-bubble-chart/actions/workflows/ci.yml)
+[![Test and Lint](https://github.com/teociaps/github-bubble-chart/actions/workflows/test.yml/badge.svg)](https://github.com/teociaps/github-bubble-chart/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/teociaps/github-bubble-chart/graph/badge.svg?token=7RKP37CX4F)](https://codecov.io/gh/teociaps/github-bubble-chart)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/teociaps/github-bubble-chart?label=Latest%20Release)
 
-Example teociaps:
+![GitHub issues](https://img.shields.io/github/issues/teociaps/github-bubble-chart)
+![GitHub pull requests](https://img.shields.io/github/issues-pr/teociaps/github-bubble-chart)
+![GitHub last commit](https://img.shields.io/github/last-commit/teociaps/github-bubble-chart)
+![GitHub license](https://img.shields.io/github/license/teociaps/github-bubble-chart)
 
-![teociaps](https://github-bubble-chart.vercel.app?username=teociaps&title-size=34&title-color=red&legend=true&legend-align=left&percentages=true)
+Insert a bubble chart into your GitHub profile readme. This makes for a great [GitHub profile readme](https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme).
 
----
+## Usage
 
-Example Test:
+You can insert the bubble chart into your GitHub profile readme by using the following URL format:
 
-![Test](https://github-bubble-chart.vercel.app/?username=test&width=800&height=600)
+```
+https://github-bubble-chart.vercel.app?username=<your-github-username>
+```
+
+For detailed usage instructions, please refer to our [Wiki](https://github.com/teociaps/github-bubble-chart/wiki).
+
+### Examples
+
+#### Basic Example
+
+![teociaps](https://github-bubble-chart.vercel.app?username=teociaps&theme=dark_high_contrast&title-size=34&title-color=red&legend-align=left)
+
+#### Custom Configuration Example
+
+![Test](https://github-bubble-chart.vercel.app/?username=teociaps&mode=custom-config&config-path=ghbc-my-tech-and-tools.json)
+
+## Breaking Changes & Releases
+
+For any new releases or breaking changes, please visit our [Releases Wiki](https://github.com/teociaps/github-bubble-chart/wiki/Releases) for detailed information.
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+Please refer to our [Contributing Guide](CONTRIBUTING.md) for detailed information on how to contribute.
+
+## License
+
+Distributed under the [MIT License](LICENSE).