Update README.md

Author: max01app

README.md

@@ -1,31 +1,55 @@
 # vue-rss-feed
+A simple componenet to embed beautiful RSS feeds with Vuejs
 
-## Project setup
+## Demo
+[demo](https://rssapp.github.io/vue-rss-feed/)
 
-```
-npm install
+## Install
+
+```bash
+npm i vue-rss-feed
 ```
 
-### Compiles and hot-reloads for development
+## Usage
+Import VueRssFeed in your component
 
-```
-npm run serve
+```js
+import VueRssFeed from "../VueRssFeed.vue";
+...
+export default {
+ name: "Demo",
+ components: {
+ VueRssFeed
+ },
+ data() {
+ return {
+ feedUrl: "https://rss.app/feeds/hmsyAr3PyniBpmOd.xml",
+ name: "",
+ limit: 5, 
+ };
+ },
+};
 ```
 
-### Compiles and minifies for production
+Then use it in the template
 
-```
-npm run build
+```HTML
+<template>
+...
+<div>
+ <VueRssFeed :feedUrl="feedUrl" :name="name" :limit="limit"/>
+</div>
+... 
+</template> 
 ```
 
-### Run your tests
+## Props
 
-```
-npm run test
-```
 
-### Lints and fixes files
+| name | type | default | description |
+| --------------- | -------------------------------- | ---------- | ---------------------------------------------------------------------- |
+| feedUrl | String | | RSS Feed URL |
+| limit | Number | 5 | Number of items to render |
+| Name | String | | Pass a name to show instead of feed title |
+
 
-```
-npm run lint
-```