Merge pull request #26 from tmr08c/tmr08c-add-how-to-use-to-readme

Adds "how to use this project" to the README
This commit is contained in:
Yigit Cukuren
2020-06-14 00:47:41 +03:00
committed by GitHub

View File

@@ -7,8 +7,26 @@
* Dark/light mode * Dark/light mode
* Color variations * Color variations
## How to use this project
[![tailblocks](https://github.com/mertjf/tailblocks/blob/master/public/preview.gif)](https://mertjf.github.io/tailblocks) [![tailblocks](https://github.com/mertjf/tailblocks/blob/master/public/preview.gif)](https://mertjf.github.io/tailblocks)
This project provides multiple templates built using [Tailwind
CSS](https://tailwindcss.com/) that you can use in your own projects. This
project is not a dependency that you add to your project, but instead provides
you with HTML that you can easily copy and paste into your own project.
To use the project:
1. Go to the [demo site](https://mertjf.github.io/tailblocks/)
1. Find a template that you would like to use
1. Select the colorscheme you want with the colorscheme-picker
1. Select whether you would like to use light or dark mode with the picker
1. Click the "View Code" button
1. Copy/paste into your project
1. 🎉
## License ## License
Code copyright 2020 Mert Cukuren. Code released under [the MIT license](https://github.com/mertjf/tailblocks/blob/master/LICENSE). Code copyright 2020 Mert Cukuren. Code released under [the MIT license](https://github.com/mertjf/tailblocks/blob/master/LICENSE).