Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adds "how to use this project" to the README #26

Merged
merged 1 commit into from
Jun 13, 2020
Merged

Adds "how to use this project" to the README #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
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).