Merge pull request LucasLeandro1204#12 from luizperes/doc-editing

Docs reviewing/editing

Author: LucasLeandro1204

README.md

@@ -1,10 +1,10 @@
 # Vue Content Loading
 
-### Vue component to easily build (or use presets) SVG loading cards Facebook like.
+### Vue component to easily build or use presets for Facebook-like SVG loading cards.
 
 > Inspired in [React Content Loader](https://github.com/danilowoz/react-content-loader)
 
-## So how it looks like?
+## So how does it look like?
 
 Facebook
 
@@ -16,14 +16,14 @@ Code
 
 # Documentation & Examples
 
-Documentation with all presets is available at [HERE](https://lucasleandro1204.github.io/vue-content-loading)
+Documentation with all presets is available [HERE](https://lucasleandro1204.github.io/vue-content-loading)
 
 ## Installation
 
-Simple install via NPM
+Simple installation via NPM
 
 ``$ npm install vue-content-loading --save``
 
 ##### License
 
-This project is licensed under the MIT license. See the LICENSE file for more details
+This project is licensed under the MIT license. See the [LICENSE file](./LICENSE) for more details

docs/README.md

@@ -1,6 +1,6 @@
 # Vue Content Loading
 
-**Vue component to easily build (or use presets) SVG loading cards Facebook like**
+**Vue component to easily build or use presets for Facebook-like SVG loading cards**
 
 > Inspired in [React Content Loader](https://github.com/danilowoz/react-content-loader)
 
@@ -12,4 +12,4 @@
 
 ## License
 
-This project is licensed under the MIT license. See the LICENSE file for more details
+This project is licensed under the MIT license. See the [LICENSE file](https://github.com/LucasLeandro1204/vue-content-loading/blob/master/LICENSE) for more details.

docs/development.md

@@ -1,6 +1,6 @@
 # Development
 
-Fork the repo then clone it
+Fork and clone the repo
 
 ``$ git clone [email protected]:YourUsername/vue-content-loading.git && cd vue-content-loading``
 
@@ -16,16 +16,16 @@ This will host the application at localhost:8080
 
 ## Production
 
-To build for production run
+To build for production, run:
 
 ``$ npm run build``
 
-The above command bundle the app and also features minification to help reduce file size
+The above command bundles and minifies the app files.
 
 ## Linting
 
 ``$ npm run lint``
 
-To automatically fix the problems, run
+To automatically fix linting problems, run:
 
 ``$ npm run lint:fix``

docs/guide.md

@@ -2,19 +2,19 @@
 
 ## Installation
 
-Simple install via NPM
+Simple installation via NPM
 
 ``$ npm install vue-content-loading --save``
 
 ## Usage
 
-First import it
+Firstly, import it:
 
 ```javascript
   import { VclFacebook, VclInstagram } from 'vue-content-loading';
 ```
 
-Then define as component
+Then define it as a component
 
 ```vue
   <script>
@@ -27,7 +27,7 @@ Then define as component
   </script>
 ```
 
-Now you can use it like you use any other else component =)
+Now you can use it just like you use any other vue component =)
 
 ```vue
   <template>
@@ -36,11 +36,11 @@ Now you can use it like you use any other else component =)
   </template>
 ```
 
-*You can bind custom attrs to presets too xd*
+*You may as well bind custom attrs to presets xd*
 
 ## Options
 
-Every preset accept the props below, but presets *maybe* have custom props
+All presets accept the props below, but they *may* have other custom props
 
 | Prop      | Type   | Default | Description      |
 |:---------:|:------:|:-------:|:----------------:|
@@ -50,7 +50,7 @@ Every preset accept the props below, but presets *maybe* have custom props
 | primary   | String | #f0f0f0 | SVG Background   |
 | secondary | String | #e0e0e0 | Animation color  |
 
-Color props are required to be HEX with hash prefix.
+Color props are required to be *HEX* with a proper pound sign ('#') as its prefix.
 
 *Props are validate, so it minimize mistakes xd*
 
@@ -78,4 +78,4 @@ It's really simple to build a preset, you only need to know the basics of SVG
   </template>
 ```
 
-*If you let vue-content-loading component empty, the default one will be facebook*
+*If you do not specify a vue-content-loading component, Facebook's preset will be used as default*

docs/index.html

@@ -2,9 +2,9 @@
 <html lang="en">
 <head>
   <meta charset="UTF-8">
-  <title>Vue Content Loading - SVG loading cards Facebook like.</title>
+  <title>Vue Content Loading - Facebook-like SVG loading cards.</title>
   <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
-  <meta name="description" content="Vue component to easily build (or use presets) SVG loading cards Facebook like">
+  <meta name="description" content="Vue component to easily build or use presets for Facebook-like loading cards">
   <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
   <link href="https://fonts.googleapis.com/css?family=Ubuntu:400,500,700" rel="stylesheet">
   <link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.css" rel="stylesheet">