Add Readme.

Author: zachleigh

README.md

@@ -1,18 +1,81 @@
-# Laravel Lang Bundler   
-[![Build Status](https://travis-ci.org/zachleigh/laravel-lang-bundler.svg?branch=master)](https://travis-ci.org/zachleigh/laravel-lang-bundler)
-[![Latest Stable Version](https://poser.pugx.org/zachleigh/laravel-lang-bundler/version.svg)](//packagist.org/packages/zachleigh/laravel-lang-bundler)
-[![Total Downloads](https://poser.pugx.org/zachleigh/laravel-lang-bundler/downloads)](https://packagist.org/packages/zachleigh/laravel-lang-bundler)
-[![StyleCI](https://styleci.io/repos/72352058/shield?style=flat)](https://styleci.io/repos/72352058)
-[![License](https://poser.pugx.org/zachleigh/laravel-lang-bundler/license.svg)](//packagist.org/packages/zachleigh/laravel-lang-bundler)  
-##### Make bundles of translation values. 
+# Laravel Vue Generators   
+[![Build Status](https://travis-ci.org/zachleigh/laravel-vue-generators.svg?branch=master)](https://travis-ci.org/zachleigh/laravel-vue-generators)
+[![Latest Stable Version](https://poser.pugx.org/zachleigh/laravel-vue-generators/version.svg)](//packagist.org/packages/zachleigh/laravel-vue-generators)
+[![Total Downloads](https://poser.pugx.org/zachleigh/laravel-vue-generators/downloads)](https://packagist.org/packages/zachleigh/laravel-vue-generators)
+[![StyleCI](https://styleci.io/repos/73324143/shield?style=flat)](https://styleci.io/repos/72352058)
+[![License](https://poser.pugx.org/zachleigh/laravel-vue-generators/license.svg)](//packagist.org/packages/zachleigh/laravel-vue-generators)  
+##### Generate Vue js file stubs via artisan commands. 
 
 ### Contents
-  - [Why](#why)
   - [Install](#install)
   - [Usage](#usage)
-  - [Advanced Usage](#advanced-usage)
-  - [Commands](#commands)
-  - [Configuration](#configuration)
-  - [Limitations](#limitations)
   - [Testing](#testing)
-  - [Contributing](#contributing)
+  - [Contributing](#contributing)
+
+### Install
+Install via composer:
+```
+composer require zachleigh/laravel-vue-generators
+```
+In Laravel's config/app.php file, add the service provider to the array with the 'providers' key.
+```
+VueGenerators\ServiceProvider::class
+```    
+
+### Usage
+This package currently contains two commands: `component` and `mixin`.      
+##### component
+Create a Vue js component file.
+```
+php artisan vueg:component {name} {--empty} {--path=assets.js.components}
+```
+###### name
+Name of the component.
+```
+php artisan vueg:component MyComponent
+```
+Will create a file called MyComponent.vue at resources/assets/js/components/MyComponent.vue.
+###### empty
+By default, the component will be filled with all available component methods (data, props, computed etc.). Use empty flag to create an empty component with no methods.
+```
+php artisan vueg:component MyComponent --empty
+```
+Will create a file with no component methods.
+###### path
+By default, all components will be saved in resources/assets/js/components/. Specify a custom, period divide path with the path flag. Path root is in resources/.
+```
+php artisan vueg:component MyComponent --path=assets.js.custom.folder
+``` 
+Will create a file called MyComponent.vue at resources/assets/js/custom/folder/MyComponent.vue.
+
+##### mixin
+Create a Vue js mixin file.
+```
+php artisan vueg:mixin {name} {--empty} {--path=assets.js.mixins}
+```
+###### name
+Name of the mixin.
+```
+php artisan vueg:mixin MyMixin
+```
+Will create a file called MyMixin.vue at resources/assets/js/mixins/MyMixin.vue.
+###### empty
+By default, the mixin will be filled with all available mixin methods (data, props, computed etc.). Use empty flag to create an empty mixin with no methods.
+```
+php artisan vueg:mixin MyMixin --empty
+```
+Will create a file with no mixin methods.
+###### path
+By default, all mixins will be saved in resources/assets/js/mixins/. Specify a custom, period divide path with the path flag. Path root is in resources/.
+```
+php artisan vueg:mixin MyMixin --path=assets.js.custom.folder
+``` 
+Will create a file called MyMixin.vue at resources/assets/js/custom/folder/MyMixin.vue.
+
+### Testing
+```
+composer test
+```
+
+### Contributing
+Contributions are more than welcome. Fork, improve and make a pull request. For bugs, ideas for improvement or other, please create an [issue](https://github.com/zachleigh/laravel-lang-bundler/issues).