From d555e49f0311118b3ec99cf9e17aa42460767d89 Mon Sep 17 00:00:00 2001 From: Troy Rosenberg Date: Sun, 31 May 2020 16:58:59 -0400 Subject: [PATCH] Adds "how to use this project" to the README 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. --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index f0a3004..af01236 100644 --- a/README.md +++ b/README.md @@ -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).