added logo, badges and updated guide section

README.md

@@ -1,3 +1,10 @@
+[![npm version](https://badge.fury.io/js/vue-snap.svg)](https://badge.fury.io/js/vue-snap)
+[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/apertureless/vue-chartjs/blob/master/LICENSE.txt)
+
+<div align="center">
+  <img width="256" heigth="256" src="/static/snap.jpg" alt="vue-snap logo">
+</div>
+
 # vue-snap
 > Lightweight Slider/Carousel based on CSS Scroll Snap and Vue
 

docs/docs/.vuepress/config.js

@@ -1,11 +1,17 @@
 module.exports = {
   title: 'VueSnap',
-  description: 'Lightweight Slider/Carousel based on CSS Scroll Snap and Vue',
+  description: 'Lightweight Slider/Carousel based on CSS Scroll Snap',
   themeConfig: {
     nav: [
       { text: 'Guide', link: '/guide/' },
-      // { text: 'Examples', link: '/examples/' },
-      // { text: 'API', link: '/api/' }s
-    ]
+      { text: 'Examples', link: '/examples/' },
+      { text: 'API', link: '/api/' }
+    ],
+    repo: 'bartdominiak/vue-snap',
+    editLinks: true,
+    editLinkText: 'Help us improve this page!',
+    serviceWorker: true,
+    docsDir: 'docs',
+    docsBranch: 'master'
   }
 }

docs/docs/README.md

@@ -1 +1,14 @@
-# Hello VuePress
+---
+home: true
+heroImage: /snap.svg
+actionText: Get Started →
+actionLink: /guide/
+features:
+- title: Fully responsive
+  details: With the full power of CSS 💪
+- title: Optimised
+  details: Without heavy calculations 💯
+- title: Performance
+  details: Reduce the overall load time of your site 💪
+footer: MIT Licensed | Copyright © 2020 Bartosz Dominiak
+---