diff --git a/README.md b/README.md
index 7c85c9a..c1209f6 100644
--- a/README.md
+++ b/README.md
@@ -8,11 +8,9 @@ _High Quality web friendly icons_
'Boxicons' is a carefully designed open source iconset with 700+ icons. It's crafted to look enrich your website/app experience.
-_Announcing Boxicons v1.5.1!_
+_Announcing Boxicons v1.5.2!_
-Solid icons have been added with a seperate logos category
-
-You can check out the detailed documentation [here](https://boxicons.com/get-started)
+Load the icons as web component , load only the icons you need .
## Installation
@@ -25,7 +23,7 @@ $ npm install boxicons --save
import the module
```javscript
-import 'boxicons/css/boxicons.css';
+import 'boxicons/dist/boxicons.js';
```
## Usage
@@ -44,10 +42,10 @@ Instead of installing you may use the remote version
```html
+ href="https://cdn.jsdelivr.net/npm/boxicons@latest/css/boxicons.min.css">
+ href="https://unpkg.com/boxicons@latest/css/boxicons.min.css">
```
@@ -59,6 +57,58 @@ Instead of installing you may use the remote version
```
+### Using via Web Component
+
+Boxicons includes a Custom Element that makes using icons easy and efficient. To use it, add the `box-icon-element.js` file to the page:
+
+```html
+
+```
+
+To use an icon, add the `` element to the location where the icon should be displayed:
+
+```html
+
+```
+ To use solid icons or logos add attribute `type` as solid or logo
+ ```html
+
+
+```
+The `` custom element supports the following attributes:
+
+```html
+
+```
+
+- `name` : (REQUIRED) the name of the icon to be displayed
+- `color`: A color for the icon.
+- `size`: The size for the icon. It supports one of two types of values:
+ - One of the followign shortcuts: `xs`, `sm`, `md`, `lg`
+ - A css unit size (ex. `60px`)
+- `rotate`: one of the following values: `90`, `180`, `270`
+- `flip`: one of the following values: `horizontal`, `vertical`
+- `border`: one of the following values: `square`, `circle`
+- `animation`: One of the following values: `spin`, `tada`, `flashing`, `burst`, `fade-left`, `fade-right`, `spin-hover`, `tada-hover`, `flashing-hover`, `burst-hover`, `fade-left-hover`, `fade-right-hover`
+- `type`: one of the following values: `regular`,`solid`, `logo`
+- `pull`: one of the following values: `left`,`right`
+The Custom Element class (`BoxIconElement`) exposes the following static members:
+
+- `tagName`: property that holds the HTML element tag name. Default: `box-icon`
+- `defined([tagName])`: Defines the Element in the custom element registry using either the tagName provided on input or the (default) the one defined on the Class.
+- `cdnUrl`: property that holds the URL that will be used to retrieve the images. URL should point to the folder that contains the images. example: `//unpkg.com/boxicons@1.5.2/svg` (no trailing forward slash)
+- `getIconSvg(iconName)`: method used to retrieve the SVG image. Should return a Promise that resolves with the SVG source (String).
+
[Check out all the icons here!](https://boxicons.com)
diff --git a/dev.box-icon-element.html b/dev.box-icon-element.html
index 5f886c4..dd49fb2 100644
--- a/dev.box-icon-element.html
+++ b/dev.box-icon-element.html
@@ -51,8 +51,8 @@
- Shape
-