diff --git a/README.md b/README.md new file mode 100644 index 0000000..99668bd --- /dev/null +++ b/README.md @@ -0,0 +1,100 @@ +# ifeeds + +One of the most useful features of Blogger is its ability to generate feeds, and based on this, I developed a plugin that creates widgets, allowing visitors with their own blogs and who enjoy your content to display your latest posts as a sign of appreciation. + +## Install + +### npm + +``` +npm i ifeeds +``` + +### cdn + +```html + +``` + +## Basic Usage + +### Builder Mode + +It provides controls for users to configure the plugin, this would be the minimum structure: + +```html + +
+ + + + + + + + + +
+ + +
+ + +
+ + +
+``` + +Finally (after including **feeds.js**), use the `initCustomizer` method to use the script in "Creator" mode: + +```js +Feeds.initCustomizer() +``` + +Example: [codepen.io/zkreations/pen/poOvXVY](https://codepen.io/zkreations/pen/poOvXVY) +Custom example: [codepen.io/zkreations/pen/zYJxZyR](https://codepen.io/zkreations/pen/zYJxZyR) + +### Plugin Mode + + +In this mode, only the container is required: + +```html +
+``` + +Now you need to initialize it using the `initPlugin` method to display the feed: + +```js +Feeds.initPlugin() +``` + +## Options + +Both previously mentioned methods share the same options, here is a table with more information: + +| Option | Type | Default +| -------------- | ---------- | --------- +| `url` | string | `origin` +| `max` | number | `5` +| `direction` | string | `column` +| `image` | string | `https://i.imgur.com/snnjdGS.png` +| `imageSize` | string | `w300-h240-c` +| `title` | string | `#212121` +| `category` | string | `#212121` +| `categorybg` | string | `#f1f1f1` +| `border` | string | `#e6e6e6` +| `background` | string | `#ffffff` +| `label` | string | `#ffffff` +| `styles` | boolean | `true` + +## License + +**feeds.js** is licensed under the MIT License + +Inspiration: [somoskudasai](https://somoskudasai.com/webmasters/)