From 9874968a66a15fd16a458df17db006f836b2b31b Mon Sep 17 00:00:00 2001 From: Louis Charette Date: Mon, 24 Jun 2024 13:51:36 -0400 Subject: [PATCH] Update README --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1690c78..bebee42 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,21 @@ -# Pink Cupcake Theme +# Pink Cupcake Theme For UserFrosting 6 + +[![Version](https://img.shields.io/npm/v/%40userfrosting%2Ftheme-pink-cupcake)](https://www.npmjs.com/package/@userfrosting/theme-pink-cupcake) +[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE) +[![Build](https://img.shields.io/github/actions/workflow/status/userfrosting/theme-pink-cupcake/Build.yml?branch=main&logo=github)](https://github.com/userfrosting/theme-pink-cupcake/actions) +[![Codecov](https://codecov.io/gh/userfrosting/theme-pink-cupcake/branch/main/graph/badge.svg)](https://app.codecov.io/gh/userfrosting/theme-pink-cupcake/branch/main) +[![Donate](https://img.shields.io/badge/Open_Collective-Donate-blue?logo=Open%20Collective)](https://opencollective.com/userfrosting#backer) +[![Donate](https://img.shields.io/badge/Ko--fi-Donate-blue?logo=ko-fi&logoColor=white)](https://ko-fi.com/lcharette) Frontend theme for [UserFrosting](https://www.userfrosting.com), built with [UiKit](https://getuikit.com) for [Vue.js](https://vuejs.org). -> [!WARNING] -> This is still a work in progress +Copyright (c) 2024, free to use in personal and commercial software as per the [license](LICENSE.md). For an example/test of the implementation, see : [Theme Pink Cupcake Example](https://github.com/userfrosting/theme-pink-cupcake-example) +> [!WARNING] +> This is still a work in progress + ## Recommended IDE Setup [VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).