@vubrussel/vub_tailwind/README.md

Vue and Tailwind CSS based frontend components with VUB specific layout.

# VUB Tailwind component library 
Vue and Tailwind CSS based frontend components with VUB specific layout. 

Build VUB web application faster by having a set of components that adhere to the VUB house style. 

# Getting Started

Make sure that you have Vue and Tailwind CSS installed.

1.	Install VUB Tailwind with npm or yarn:

```
    npm install @vubrussel/vub_tailwind
```
```
    yarn add @vubrussel/vub_tailwind
```

2. Require VUB Tailwind as a plugin in the `tailwind.config.js` file:

```
module.exports = {

    plugins: [
        require('@vubrussel/vub_tailwind/plugin')
    ]
}
```

3. Add the template path to the `tailwind.config.js` file:

```
module.exports = {
    content: [
        "./assets/**/*.{vue,html,js}",
        "./templates/**/*.html.twig",
        "./node_modules/@vubrussel/vub_tailwind/src/**/*.vue",
    ],
    
}
```


#	Software dependencies

- [Vue.js](https://vuejs.org/guide/quick-start.html) (^3.0.0)
- [Tailwind CSS](https://tailwindcss.com/docs/installation)



<!-- # Build and Test
TODO: Describe and show how to build your code and run the tests. 

# Contribute
TODO: Explain how other users and developers can contribute to make your code better. 

If you want to learn more about creating good readme files then refer the following [guidelines](https://docs.microsoft.com/en-us/azure/devops/repos/git/create-a-readme?view=azure-devops). You can also seek inspiration from the below readme files:
- [ASP.NET Core](https://github.com/aspnet/Home)
- [Visual Studio Code](https://github.com/Microsoft/vscode)
- [Chakra Core](https://github.com/Microsoft/ChakraCore) -->