Skip to content

Commit d8b4f50

Browse files
committed
[Update] README.md
1 parent cc27a4d commit d8b4f50

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
* [✔️] Easy to use
3535
* [✔️] MIT License
3636
* [✔️] Without jQuery depencence
37+
* [✔️] Configurable with attributes
3738
* [✔️] Work with: Browserify / Webpack / ReactJS / Angular / Wordpress
3839
* [✔️] My Patreon Tier Box with avatars and link from rest/json api.
3940
* [✔️] Translations: 🇬🇧 🇮🇹 🇵🇱 (Help me ❤️)
@@ -44,7 +45,7 @@ See [Demo here](https://codepen.io/ptkdev/pen/abvLgOE). Photos from ptkdev's pat
4445
[![WebComponent: PatreonBox](https://raw.githubusercontent.com/ptkdev-components/webcomponent-patreon-box/nightly/.github/assets/screenshot/webcomponent-patreon-box-screen1.png?)](https://raw.githubusercontent.com/ptkdev-components/webcomponent-patreon-box/nightly/.github/assets/screenshot/webcomponent-patreon-box-screen1.png)
4546

4647
## 🚀 Installation (Web)
47-
1. Add html code to your page (and replace `@ptkdev` with your patreon username):
48+
1. Add html code to your page (and replace `api` with your endpoint):
4849
```html
4950
<patreon-box api="https://api.ptkdev.io/backers/" image-width="80px" image-height="80px" />
5051
```
@@ -59,7 +60,7 @@ See folder `examples`, run with `npm run example`. Below is available a descript
5960

6061
## 📦 Installation (NPM Module - Browserify/Webpack)
6162
1. Install npm module: `npm install @ptkdev/webcomponent-patreon-box --save`
62-
2. Add html code to your page (and replace `@ptkdev` with your patreon username):
63+
2. Add html code to your page (and replace `api` with your endpoint):
6364
```html
6465
<patreon-box api="https://api.ptkdev.io/backers/" image-width="80px" image-height="80px" />
6566
```
@@ -76,7 +77,7 @@ See folder `examples`, run with `npm run example`. Below is available a descript
7677

7778
## 📖 Installation (Wordpress)
7879
1. Download [wordpress-plugin](https://github.com/ptkdev-components/webcomponent-patreon-box/raw/nightly/dist/wordpress/patreon-box-wordpress-plugin.zip) and install it.
79-
1. Add code to your html widget, example: `Appearance` --> `Widget` --> insert `HTML Widget` and paste html code (and replace `@ptkdev` with your patreon username):
80+
1. Add code to your html widget, example: `Appearance` --> `Widget` --> insert `HTML Widget` and paste html code (and replace `api` with your endpoint):
8081
```html
8182
<patreon-box api="https://api.ptkdev.io/backers/" image-width="80px" image-height="80px" />
8283
```
@@ -89,7 +90,7 @@ You can insert this html code in posts, widget, html box or theme. Where you wan
8990
```javascript
9091
import '@ptkdev/webcomponent-patreon-box';
9192
```
92-
3. Add html code to your `App.js` template (and replace `@ptkdev` with your patreon username):
93+
3. Add html code to your `App.js` template (and replace `api` with your endpoint):
9394
```html
9495
<patreon-box api="https://api.ptkdev.io/backers/" image-width="80px" image-height="80px" />
9596
```
@@ -102,7 +103,7 @@ Below is available a description of `options` values and all logger methods.
102103
```javascript
103104
import '@ptkdev/webcomponent-patreon-box';
104105
```
105-
3. Add html code to your html component (and replace `@ptkdev` with your patreon username):
106+
3. Add html code to your html component (and replace `api` with your endpoint):
106107
```html
107108
<patreon-box api="https://api.ptkdev.io/backers/" image-width="80px" image-height="80px" />
108109
```

0 commit comments

Comments
 (0)