Merge pull request #4 from mkocansey/main

Minor doc updates

README.md

@@ -3,14 +3,68 @@
 ## About BladewindUI
 
 BladewindUI is a collection of UI components written purely using TailwindCSS, Laravel blade templates and Vanilla Javascript. These components are super simple to use and come with different levels of customization.
+<br /><br />
+
+### Installation
+The full installatioin guide is available on https://bladewindui.com.
+<br />
+
+BladewindUI is very specific to Laravel since all components are written purely using blade syntax. To install in your Laravel project simply run this command in the terminal at the root of your project.
+<br /><br />
+
+```
+composer require mkocansey/bladewind
+```
+<br />
+
+Next you need to **publish the package assets** by running this command, still in the terminal at the root of your Laravel project.
+
+<br />
+
+```
+php artisan vendor:publish --provider="Mkocansey\Bladewind\BladewindServiceProvider" --tag=assets --force
+```
+<br />
+
+Now include the BladewindUI css file in the &lt;head&gt; of your pages. This should ideally be done in the layouts file your app pages extend from.
+
+<br />
+
+```
+<link href="{{ asset('bladewind/css/animate.min.css') }}" rel="stylesheet" />
+```
+```
+<link href="{{ asset('bladewind/css/bladewind-ui.min.css') }}" rel="stylesheet" />
+```
+
+<br />
+
+Finally, include the BladewindUI javascript file anywhere before the closing of the &lt;/body&gt; tag of your pages. Again, this should ideally be done in the layouts file your app's pages extend from.
+
+<br />
+
+```
+<script src="{{ asset('bladewind/js/helpers.js') }}" type="text/javascript"></script>
+```
+
+<br />
+
+You are now ready to start using any of the BladewindUI components in your application
+
+<br />
+
+```
+<x-bladewind.button> Save User </x-bladewind.button>
+```
+
 <br /><br />
 ### Components Include
 
 - **[Alert](https://bladewindui.com/component/alert)**
 - **[Avatar](https://bladewindui.com/component/avatar)**
 - **[Button](https://bladewindui.com/component/button)**
 - **[Card](https://bladewindui.com/component/card)**
-- **[Centered Element](https://bladewindui.com/component/centered-element)**
+- **[Centered Content](https://bladewindui.com/component/centered-content)**
 - **[Checkbox](https://bladewindui.com/component/checkbox)**
 - **[Datepicker](https://bladewindui.com/component/datepicker)**
 - **[Dropdown](https://bladewindui.com/component/dropdown)**
@@ -35,6 +89,10 @@ BladewindUI is a collection of UI components written purely using TailwindCSS, L
 
 <br /><br />
 
+Check out the full documentation on https://bladewindui.com.
+
+<br /><br />
+
 ## Security Vulnerabilities
 
 If you discover a security vulnerability, please e-mail Michael K. Ocansey at [[email protected]](mailto:[email protected]).
@@ -43,4 +101,4 @@ If you discover a security vulnerability, please e-mail Michael K. Ocansey at [k
 
 ## License
 
-BladewindUI components is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
+BladewindUI components is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).