Mirroring/tailblocks
1
0
Fork 0
mirror of https://github.com/mertJF/tailblocks.git synced 2025-12-08 17:03:24 +00:00
Code Issues Projects Releases Wiki Activity

Adds "how to use this project" to the README

Browse Source 
Since this project is not a traditional dependency [it may not be
obvious](https://github.com/mertJF/tailblocks/issues/14) how it is
expected to be used.

This commit adds a section to the README that can hopefully make it
easier to know how to use this project.
This commit is contained in:
Troy Rosenberg
2020-05-31 16:58:59 -04:00
parent 44b9a41d37
commit d555e49f03
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -7,8 +7,26 @@
* Dark/light mode
* Color variations
## How to use this project
[![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
Code copyright 2020 Mert Cukuren. Code released under [the MIT license](https://github.com/mertjf/tailblocks/blob/master/LICENSE).