Merge branch 'release/0.1.0-alpha.1'

Author: Bartosz Dominiak

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 .DS_Store
-dist
+dist/stats.json
+storybook-static

App.vue

@@ -0,0 +1,11 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0-alpha.1] - 2020-06-12
+### Added
+- Project init

CHANGELOG.md

@@ -1,14 +1,49 @@
-# vue-carousel
+# vue-snap
+> Lightweight Slider/Carousel based on CSS Scroll Snap and Vue
 
 ## About
-This is PoC Carousel (Slider) based on Scroll Snap and Observer API. I'm currently looking for best way to improve sliders performence for one of my client. With scroll snap we're not obligated to load additional libs with heavy calculations.
+Please note that this lib is on very early stage. The idea behind this plugin is that to create fully responsive and well optimised Carousel. I created this as PoC for one of my biggest client, who wants to speed up his website, with other than existing solutions like VueCarousel.
 
-## Know issues (Bugs)
-- Snap scrolling not supported in IE
+## Benefits:
+- Lightweight and Fully responsive
+- You can set how many slides you want to display per current breakpoint
+- There is no calculation or heavy logic inside (Performence)
+- All custamization via CSS
+
+## Know issues / limitless
+- Not supported in IE
+- Carousel not working properly with unknown Slides width
+- Missing CSS recalculation for dynamicly added Slides
+
+## Usage
+There are two ways to run it.
+
+### Globally
+
+```js
+import Vue from 'vue'
+import VueSnap from 'vue-snap'
+
+Vue.use(VueSnap)
+```
+
+### Locally
+
+```js
+import { Carousel, Slide } from 'vue-snap'
+
+export default {
+  components: {
+    Carousel,
+    Slide
+  }
+}
+```
 
 ## Development
 
-Install necessary depandancies
+Install necessary depandancies with yarn or npm
+
 ```
   yarn
 ```