From 1367efabbd8ce80b3dc11b89935a5f122e365869 Mon Sep 17 00:00:00 2001
From: 0xdv <0xc0ffec0de@gmail.com>
Date: Sun, 22 Mar 2020 17:12:10 +0200
Subject: [PATCH] Create README.md

---
 README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d9b6561
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# vue-timeline-component
+
+[![npm package](https://img.shields.io/npm/v/vue-timeline-component.svg)](https://www.npmjs.org/package/vue-timeline-component)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/0xdv/vue-timeline-component/blob/master/LICENSE)
+
+## Install
+
+```js
+npm install vue-timeline-component
+```
+
+## Usage
+
+```html
+<template>
+  <div id="app">
+    <vue-timeline :data="data"></vue-timeline>
+  </div>
+</template>
+```
+
+```js
+<script>
+import VueTimeline from "vue-timeline-component"
+
+export default {
+  name: 'App',
+  components: {
+    VueTimeline
+  },
+  data() {
+    return {
+      data: [{
+          id: 1,
+          name: "example",
+          start: new Date(2001, 1,1),
+          end: new Date(2020, 1,1),
+          position: 5
+      }]
+    }
+  },
+}
+</script>
+```