Merge pull request LucasLeandro1204#9 from LucasLeandro1204/landing-page

Landing page

Author: LucasLeandro1204

.editorconfig

@@ -0,0 +1,22 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[**.js*]
+indent_style = space
+indent_size = 2
+
+[**.vue]
+indent_style = space
+indent_size = 2
+
+[**.html]
+indent_style = space
+indent_size = 2

.gitignore

@@ -4,6 +4,7 @@ dist/vuecontentloading.js
 dist/vuecontentloading.js.map
 npm-debug.log
 yarn-error.log
+package-lock.json
 
 # Editor directories and files
 .idea

README.md

@@ -4,97 +4,26 @@
 
 > Inspired in [React Content Loader](https://github.com/danilowoz/react-content-loader)
 
-## Installation
-
-Simply install it via NPM
-
-``$ npm install vue-content-loading --save``
-
 ## So how it looks like?
 
-##### Facebook
+Facebook
 
 ![Facebook loading](https://raw.githubusercontent.com/LucasLeandro1204/vue-content-loading/master/static/facebook.gif "Facebook loading")
 
-##### Code
+Code
 
 ![Code loading](https://raw.githubusercontent.com/LucasLeandro1204/vue-content-loading/master/static/code.gif "Code loading")
 
-[See more here](https://lucasleandro1204.github.io/vue-content-loading/)
-
-## Usage
-
-##### Presets
-
-```javascript
-  import { VclFacebook, VclInstagram } from 'vue-content-loading';
-
-  <vcl-facebook></vcl-facebook>
-
-  <vcl-instagram></vcl-instagram>
-```
-
-*You can bind custom attrs to presets too xd*
-
-##### Custom
-
-```javascript
-  import VueContentLoading from 'vue-content-loading';
-
-  <vue-content-loading :width="300" :height="100">
-    <circle cx="30" cy="30" r="30" />
-    <rect x="75" y="13" rx="4" ry="4" width="100" height="15" />
-    <rect x="75" y="37" rx="4" ry="4" width="50" height="10" />
-  </vue-content-loading>
-```
-
-*The default loading is facebook*
-
-## Options
+# Documentation & Examples
 
-#### Props
+Documentation with all presets is available at [HERE](https://lucasleandro1204.github.io/vue-content-loading)
 
-| Prop      | Type   | Default | Description      |
-|:---------:|:------:|:-------:|:----------------:|
-| speed     | Number | 2       | Animation speed  |
-| width     | Number | 400     | Width component  |
-| height    | Number | 150     | Height component |
-| primary   | String | #f0f0f0 | SVG Background   |
-| secondary | String | #e0e0e0 | Animation color  |
-
-Color props are required to be HEX with hash prefix.
-
-*Props are validate, so it minimize mistakes xd*
-
-#### Supported presets
-
-* Code *(VclCode)*
-* List *(VclList)*
-* Facebook *(VclFacebook)*
-* Instagram *(VclInstagram)*
-
-## Development
-
-To run for development run
-
-``$ npm run dev``
-
-This will host the application at localhost:8080
-
-To build for production run
-
-``$ npm run build``
-
-The above command bundle the app and also features minification to help reduce file size
-
-#### Linting
-
-``$ npm run lint``
+## Installation
 
-To automatically fix the problems, run
+Simple install via NPM
 
-``$ npm run lint:fix``
+``$ npm install vue-content-loading --save``
 
 ##### License
 
-MIT
+This project is licensed under the MIT license. See the LICENSE file for more details

dist/app.js

@@ -0,0 +1,15 @@
+# Vue Content Loading
+
+**Vue component to easily build (or use presets) SVG loading cards Facebook like**
+
+> Inspired in [React Content Loader](https://github.com/danilowoz/react-content-loader)
+
+<color-switch>
+  <template slot-scope="props">
+    <vcl-facebook :primary="props.primary" :secondary="props.secondary"></vcl-facebook>
+  </template>
+</color-switch>
+
+## License
+
+This project is licensed under the MIT license. See the LICENSE file for more details

dist/app.js.map

@@ -0,0 +1,22 @@
+- About
+  - [Introduction](?id=vue-content-loading)
+  - [License](?id=license)
+
+- Guide
+  - [Installation](guide.md?id=installation)
+  - [Usage](guide.md?id=usage)
+  - [Options](guide.md?id=options)
+  - [Custom Preset](guide.md?id=custom-preset)
+
+- Presets
+  - [Facebook](presets.md?id=facebook)
+  - [Instagram](presets.md?id=instagram)
+  - [Code](presets.md?id=code)
+  - [List](presets.md?id=list)
+  - [Bullet List](presets.md?id=bullet-list)
+  - [Twitch](presets.md?id=twitch)
+
+- Development
+  - [Getting started](development.md?id=development)
+  - [Production](development.md?id=production)
+  - [Linting](development.md?id=linting)