#update readme.md and docs

Wlada · Feb 20, 2017 · 3956642 · 3956642
1 parent 597255f
commit 3956642
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ This will make **&lt;carousel-3d&gt;** and **&lt;slide&gt;** available to all co
 
 ##### Usage (Local)
 
-Include the carousel 3d directly into your component using import:
+Include the Carousel 3d into your component using import:
 
 ``` js
 import { Carousel3d, Slide } from 'vue-carousel-3d';
@@ -53,7 +53,7 @@ export default {
 
 ## HTML Structure
 
-Once the **Carousel3d** and **Slide** components are installed globally or imported, they can be used in templates in the following manner:
+Once the **Carousel3d** and **Slide** components are installed globally or imported, they can be used in templates like below:
 
 ``` html
   <carousel-3d>
@@ -66,11 +66,11 @@ Once the **Carousel3d** and **Slide** components are installed globally or impor
   </carousel-3d>
 ```
 
-Keep in mind that **index** property on slide component is required property and you need to pass it for every slide 
+Keep in mind that **index** property on slide component is required property and you will need to pass it for every slide starting from 0 
 
 ## Development
 
-A sandboxed dev environment is provided by [vue-play](https://github.com/vue-play/vue-play). Changes made to the component files will appear in real time in the sandbox.
+Dev environment is created by [vue-play](https://github.com/vue-play/vue-play). Changes made to the component files will appear in real time in the sandbox.
 
 To begin development, run:
 
@@ -79,9 +79,9 @@ npm install
 npm run dev
 ```
 
-then navigate to `http://localhost:5000`
+now open  `http://localhost:5000` in your browser
 
-To modify and add sandbox scenarios, edit `play/index.js`
+You can modify and add scenarios in `play/index.js`
 
 ## License
 

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -3,9 +3,9 @@
 ## Source: https://github.com/hexojs/hexo/
 
 # Site
-title: Vue Carousel 3d
-subtitle:
-description: 3D Carousel for Vue.js
+title: Vue Carousel 3D
+subtitle: 
+description: Beautiful flexible and touch-friendly 3D Carousel for Vue.js
 author: Vladimir Bujanvoic
 language:
 timezone:

diff --git a/docs/source/guide/index.md b/docs/source/guide/index.md
@@ -22,7 +22,7 @@ This will make **&lt;carousel&gt;** and **&lt;slide&gt;** available to all compo
 
 ## Usage (Local)
 
-Include the carousel 3d directly into your component using import:
+Include the carousel 3d into your component using import:
 
 ``` js
 import { Carousel3d, Slide } from 'vue-carousel-3d';
@@ -39,7 +39,7 @@ export default {
 
 ## HTML Structure
 
-Once the **Carousel3d** and **Slide** components are installed globally or imported, they can be used in templates in the following manner:
+Once the **Carousel3d** and **Slide** components are installed globally or imported, they can be used in templates like below:
 
 ``` html
   <carousel-3d>
@@ -51,3 +51,23 @@ Once the **Carousel3d** and **Slide** components are installed globally or impor
     </slide>
   </carousel-3d>
 ```
+Keep in mind that **index** property on slide component is required property and you will need to pass it for every slide starting from 0 
+
+## Development
+
+Dev environment is created by [vue-play](https://github.com/vue-play/vue-play). Changes made to the component files will appear in real time in the sandbox.
+
+To begin development, run:
+
+``` bash
+npm install
+npm run dev
+```
+
+now open `http://localhost:5000` in your browser
+
+You can modify and add scenarios in `play/index.js`
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
diff --git a/docs/themes/vue/_config.yml b/docs/themes/vue/_config.yml
@@ -1,2 +1,2 @@
-site_description: "Vue Carousel 3D - A flexible,  touch-friendly 3D Carousel for Vue.js"
+site_description: "Vue Carousel 3D - Beautiful, flexible and touch-friendly 3D Carousel for Vue.js"
 vue_version: 2.1.7
diff --git a/docs/themes/vue/layout/index.ejs b/docs/themes/vue/layout/index.ejs
@@ -101,15 +101,13 @@
 
         <div class="point">
             <h2>Flexible</h2>
-            <p></p>
-            <p>Slides use Vue's built-in slot system, allowing you to display any type of content in slides (including
-                other Vue components!)</p>
+            <p>Inside slides you can display any html content or some other Vue component</p>
         </div>
 
         <div class="point">
             <h2>Touch-friendly</h2>
             <p></p>
-            <p>Touch and drag supported on both desktop and mobile devices.</p>
+            <p>Touch support enabled on mobile devices</p>
         </div>
     </div>
 </div>

diff --git a/docs/themes/vue/layout/layout.ejs b/docs/themes/vue/layout/layout.ejs
@@ -2,7 +2,7 @@
 <!DOCTYPE html>
 <html lang="en">
     <head>
-        <title><%- page.title ? page.title + ' - ' : '' %>Vue Carousel</title>
+        <title><%- page.title ? page.title + ' - ' : '' %>3D Carousel for Vue.js</title>
         <meta charset="utf-8">
         <meta name="description" content="<%- theme.site_description %>">
         <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
@@ -16,7 +16,9 @@
         <meta name="twitter:title" content="<%- page.title ? page.title + ' - ' : '' %>Vue Carousel 3d">
         <meta name="twitter:description" content="<%- theme.site_description %>">
         <meta name="twitter:image" content="https://<%- theme.root_domain %>/images/logo.png">
-
+
+        <meta name="google-site-verification" content="j7k2Vin9D3fJKlxZqkcEQK-o4eH3yJbJHwi3u2-KHwQ" />
+
         <link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600|Roboto Mono' rel='stylesheet' type='text/css'>
         <link href='//fonts.googleapis.com/css?family=Dosis:500&text=Vue.js' rel='stylesheet' type='text/css'>