From 02b25bd00bf6af53113f2503e5613a5277dd6353 Mon Sep 17 00:00:00 2001 From: Abdulrahman Date: Sat, 23 Mar 2019 17:34:36 +0300 Subject: [PATCH] update readme --- README.md | 27 ++++++++++++--------------- 1 file changed, 12 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 523f983..638650e 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,15 @@ # Tailwind Shift 🚧 -![tailwind-shift](https://i.imgur.com/xZ6ydio.png) +![tailwind-shift](https://i.imgur.com/Ldx09d8.png) [![Latest Version on Packagist](https://img.shields.io/packagist/v/awssat/tailwind-shift.svg?style=flat-square)](https://packagist.org/packages/awssat/tailwind-shift) [![StyleCI](https://styleci.io/repos/177280907/shield?branch=master)](https://styleci.io/repos/177280907) [![Build Status](https://img.shields.io/travis/awssat/tailwind-shift/master.svg?style=flat-square)](https://travis-ci.org/awssat/tailwind-shift) A helper tool to upgrade your current codes of a project to latest version of TailwindCSS without a hassle. - -## TailwindCSS versions support: It's currently support shifting from 0.7.? to 1.0 -## Installing `tailwind-shift` for CLI use +## Installing `tailwind-shift` You can install the package via composer globally: @@ -20,7 +18,7 @@ You can install the package via composer globally: Then use it to upgrade/convert a snippet, a file or a folder. -### How to Use to upgrade your project +## How to Use to upgrade your project #### Upgrade TailwindCSS config file TailwindShift offers a command to upgrade your config file, to use it: ```bash @@ -32,37 +30,36 @@ This will generate a new file called tailwind.tw.js, check the file and rename i ```bash $ tailwind-shift path/to/views/ --recursive=true --extensions=vue,php,html ``` -This will generate news files as in `view.tw.php` as a safety procedure, you could use `--replace=true` to overwrite old files. - +This will generate new files (i.e: `view.tw.php`) as a safety procedure, you could use `--replace=true` to overwrite old files. -### Advanced Usses of the command -#### Possible Options -##### Update a directory (just the files in this directory, it's not recursive) +## Advanced Usses of the command +### Possible Options +#### Update a directory (just the files in this directory, it's not recursive) ```bash $ tailwind-shift path/to/directory/ ``` -##### Recursively update a directory +#### Recursively update a directory ```bash $ tailwind-shift path/to/directory/ --recursive=true ``` You can also use the short hand `-r true` instead of the full `--recursive=true` -##### Update different file extensions +#### Update different file extensions This will allow you to upgrade your `vue`, `twig`, `css` files and more! ```bash $ tailwind-shift path/to/directory/ --extensions=vue,php,html ``` You can also use the short hand `-e vue,php,html` instead of the full `--extensions` -##### Overwrite the original files +#### Overwrite the original files _Please note this can be considered a destructive action as it will replace the orignal file and will not leave a copy of the original any where._ ```bash $ tailwind-shift path/to/directory/ --replace=true ``` -##### Update raw code +#### Update raw code just a snippet of code: ```bash @@ -77,7 +74,7 @@ $ tailwind-shift file.blade.php ``` This option works with the `--replace=true` option -##### Using the package in your project (If that's what your want) +#### Using the package in your project (If that's what your want) You can install the package via composer locally in your project folder: