Skip to content

Commit

Permalink
Added Upgrade Guide
Browse files Browse the repository at this point in the history
Signed-off-by: praveenjuge <praveen@skcript.com>
  • Loading branch information
praveenjuge committed Nov 22, 2020
1 parent db7df5c commit 4fe3473
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Kutty is a tailwind plugin for building web applications. It has a set of accessible and reusable components that are commonly used in web applications.

**Use version 0.4 for Tailwind 2, version 0.3.5 for Tailwind 1**
**Version 0.4 works for Tailwind 2, use version 0.3.5 for Tailwind 1 support.** **[Click here for an upgrade guide](http://kutty.netlify.app/articles/upgrade-guide-to-tailwindcss2/)**

## Installation

Expand Down
6 changes: 3 additions & 3 deletions docs/content/articles/upgrade-guide-to-tailwindcss2.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: "Use this as a guide to update from Kutty version 0.3.5 which suppo

Go to [Tailwind Upgrade Guide](https://tailwindcss.com/docs/upgrading-to-v2) and make sure you upgrade to the latest version.

TailwindCSS has changed the color palette which I used here with one change, I replaced `coolGray` with `blueGray` so that it looks better.
TailwindCSS has changed the main color palette which is used in kutty with one change, I replaced `coolGray` with `blueGray` because it looks better.

## Upgrade Kutty Version

Expand All @@ -22,7 +22,7 @@ npm install kutty@latest

Bundling [typography plugin](https://github.com/tailwindlabs/tailwindcss-typography) seems like a good idea at first, but it's a size increase for all the people who didn't need it. And people can't update it's version to their needs.

Now you have to install it yourself if you are using it. Make sure you install the latest version that supports TailwindCSS 2.
Now you can install it yourself if you are using it. Make sure you install the latest version that supports TailwindCSS 2.

```sh
npm install @tailwindcss/typography
Expand Down Expand Up @@ -54,4 +54,4 @@ Removed YouTube, Twitch, LinkedIn, Slack button colors as no one was using it an

## That's it

Hopefully the upgrade for easy for you :) Please [raise an issue](https://github.com/praveenjuge/kutty/issues) if you have any problems or doubts, I'll help you get through it.
Hopefully the upgrade was easy for you :) Please [raise an issue](https://github.com/praveenjuge/kutty/issues) if you have any problems or doubts, I'll help you get through it.
5 changes: 4 additions & 1 deletion docs/content/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ weight: 1

Kutty is a tailwind plugin for building web applications. It has a set of accessible and reusable components that are commonly used in web applications.

**Use version 0.4 for Tailwind 2, version 0.3.5 for Tailwind 1**
<div class="flex flex-col alert bg-primary-light text-primary" role="alert">
<span>Version 0.4 works for Tailwind 2, use version 0.3.5 for Tailwind 1 support.</span>
<a href="http://kutty.netlify.app/articles/upgrade-guide-to-tailwindcss2/">Click here for an upgrade guide</a>
</div>

## Installation

Expand Down

0 comments on commit 4fe3473

Please sign in to comment.