Skip to content

Commit

Permalink
Adds "how to use this project" to the README
Browse files Browse the repository at this point in the history
Since this project is not a traditional dependency [it may not be
obvious](mertJF#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.
  • Loading branch information
tmr08c committed May 31, 2020
1 parent 44b9a41 commit d555e49
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

0 comments on commit d555e49

Please sign in to comment.