From 895739d3c2a205d0b990f8753c15765735510862 Mon Sep 17 00:00:00 2001 From: Dulaj Ariyaratne Date: Sun, 3 Nov 2024 09:38:20 +0530 Subject: [PATCH] Update README.md --- .github/FUNDING.yml | 3 +++ README.md | 22 +++++++++++++++------- 2 files changed, 18 insertions(+), 7 deletions(-) create mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..1a02692 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +github: [dulajdeshan] +patreon: dulajdeshan +buy_me_a_coffee: dulajdeshan diff --git a/README.md b/README.md index f1f5c90..515770a 100644 --- a/README.md +++ b/README.md @@ -15,20 +15,21 @@

-Strapi Bootstrap Icons Plugin is a custom plugin for Strapi that allows to use [Bootstrap Icons](https://icons.getbootstrap.com/) for your content. +Strapi Bootstrap Icons Plugin is a custom plugin for Strapi that allows to use [Bootstrap Icons](https://icons.getbootstrap.com/) for your content. -## Installation +## ⚙️ Installation To install the Strapi Bootstrap Icons, simply run one of the following command: ``` npm install strapi-bootstrap-icons ``` + ``` yarn add strapi-bootstrap-icons ``` -## Setup +## ⚡️ Usage After installation you will find the `Bootstrap Icon` at the custom fields section of the content-type builder. @@ -46,12 +47,19 @@ Now You can create new records via the Admin panel with selecting your preferred ![strapi bootstrap icons](./screenshot/screenshot-3.png) - ![strapi bootstrap icons](./screenshot/screenshot-4.png) -## Demo +## 🖥️ Demo ![strapi bootstrap icons demo](./screenshot/demo.gif) -## License -This plugin is licensed under the MIT License. See the LICENSE file for more information. \ No newline at end of file +## 👍 Contribute + +If you want to say **Thank You** and/or support the active development of `Strapi Boostrap Icons`: + +1. Add a [GitHub Star](https://github.com/Dulajdeshan/strapi-bootstrap-icons/stargazers) to the project. +2. Support the project by donating a [cup of coffee](https://buymeacoff.ee/dulajdeshan). + +## 🧾 License + +This plugin is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more information.