diff --git a/README.md b/README.md index 223fe7b..35a92e0 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,14 @@ This library is ispried by **[Github](https://github.com/relliv?tab=overview&from=2024-10-01&to=2024-10-27)**'s contribution graph. It is a set of custom heatmap calendar components that can be used to visualize data in a calendar **[heatmap](https://en.wikipedia.org/wiki/Heat_map)** format. -WIP... +## 📄 Documentation + +Please check the **[documentation](https://ngeenx.github.io/nx-calendar-heatmap/)** for installation and usage. + +## 📚 Supported frameworks + +| Framework | Docs | Live Demo | Live Demo Source | +|---|---|---|---| +| Angular | [Docs](https://ngeenx.github.io/nx-calendar-heatmap/docs/category/angular) | [Stackblitz](https://stackblitz.com/~/github.com/ngeenx/nx-angular-calendar-heatmap-demo) | [Demo Source](https://github.com/ngeenx/nx-angular-calendar-heatmap-demo) | +| React | [Docs](https://ngeenx.github.io/nx-calendar-heatmap/docs/category/react) | [Stackblitz](https://stackblitz.com/~/github.com/ngeenx/nx-react-calendar-heatmap-demo) | [Demo Source](https://github.com/ngeenx/nx-react-calendar-heatmap-demo) | +| Vue | [Docs](https://ngeenx.github.io/nx-calendar-heatmap/docs/category/vue) | [Stackblitz](https://stackblitz.com/~/github.com/ngeenx/nx-vue-calendar-heatmap-demo) | [Demo Source](https://github.com/ngeenx/nx-vue-calendar-heatmap-demo) |