Skip to content

Commit

Permalink
Updated readme with screenshots (#5)
Browse files Browse the repository at this point in the history
- Updated instructions
- Added screenshots
  • Loading branch information
Dulajdeshan committed Oct 24, 2023
1 parent e1e23af commit e5bef4f
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@
<p align="center">
<a href="https://www.npmjs.com/package/strapi-bootstrap-icons">
<img src="https://img.shields.io/npm/v/strapi-bootstrap-icons" alt="Version">
<img src="https://img.shields.io/npm/l/strapi-bootstrap-icons
" alt="License">
<img src="https://img.shields.io/npm/l/strapi-bootstrap-icons" alt="License">
</a>
</p>

Expand All @@ -29,5 +28,30 @@ npm install strapi-bootstrap-icons
yarn add strapi-bootstrap-icons
```

## Setup

After installation you will find the `Bootstrap Icon` at the custom fields section of the content-type builder.

![strapi bootstrap icons](./screenshot/screenshot-1.png)

Now you can define the field attributes. `Bootstrap Icon` field allows you to select a response type for the field value in 3 formats.

- Base64
- SVG
- CSS Class

![strapi bootstrap icons](./screenshot/screenshot-2.png)

Now You can create new records via the Admin panel with selecting your preferred bootstrap icons.

![strapi bootstrap icons](./screenshot/screenshot-3.png)


![strapi bootstrap icons](./screenshot/screenshot-4.png)

## Demo

![strapi bootstrap icons demo](./screenshot/demo.gif)

## License
This plugin is licensed under the MIT License. See the LICENSE file for more information.
Binary file added screenshot/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshot/screenshot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshot/screenshot-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshot/screenshot-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshot/screenshot-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e5bef4f

Please sign in to comment.