Skip to content

Commit

Permalink
change readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
nafasebra committed Dec 26, 2024
1 parent a7496c8 commit 8473b43
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 35 deletions.
40 changes: 10 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,48 @@
![CSSTail icon](https://github.com/user-attachments/assets/13620693-e64e-4e56-ad57-276a8199ad54)


# CSSTail VSCode Extention

Select your properties, press right-click and select convert css to tailwind!

"CSSTail" extension is designed to streamline the process of converting traditional CSS code into corresponding Tailwind CSS utility classes. It helps developers transition to using Tailwind CSS by providing a seamless and efficient conversion tool directly in their code editor.


![preview](https://github.com/user-attachments/assets/8d02bd4a-0296-40ce-b78a-377822274655)

## Features

- ***Automated Conversion:*** Converts CSS properties into Tailwind utility classes.

- ***Inline Suggestions:*** Get Tailwind class suggestions as you type.

- ***Bulk Conversion:*** Convert entire CSS blocks into Tailwind classes with a single command.

- ***Support for Common Properties:*** Handles a wide range of CSS properties.

- ***Custom Configuration:*** Supports user-defined mappings and Tailwind theme extensions.

## Requirements and installation

1. Open VS Code.

2. Go to the Extensions Marketplace `(Ctrl+Shift+X or Cmd+Shift+X on macOS)`.

3. Search for `CSSTail`.

4. Click Install and enjoy ✌️.

## Usage

1. Highlight a CSS property or rule.

2. Right-click and select Convert to Tailwind from the context menu.

3. The CSS code will be replaced with the equivalent Tailwind class.

## Configuration

#### Tailwind Config Path

You can specify the path to your Tailwind configuration file to ensure the extension uses your custom settings:

1. Go to `File > Preferences > Settings (or Code > Preferences > Settings on macOS)`.

2. Search for CSSTail.

3. Set the path to your Tailwind config file (e.g., tailwind.config.js).


## Contribution

We welcome contributions from the community! To contribute:

- Fork the repository.
- Create a new branch for your feature or bugfix.
- Submit a pull request with a detailed description of your changes.
- Fork [the repository](https://github.com/nafasebra/csstail).
- Make your changes and commit them: `git commit -m 'Add some feature'`
- Push to the branch: `git push origin your-branch-name`
- Open a pull request on GitHub and provide a detailed description of your changes.
- Submit your pull request with a detailed description of your changes.

## License

This extension is licensed under the MIT License.

## Feedback

Have suggestions or feedback? Feel free to open an issue on our [GitHub repository](https://github.com/nafasebra/csstail).


**Enjoy!**
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"name": "css-to-tailwindcss",
"displayName": "css-to-tailwindcss",
"name": "csstail",
"displayName": "csstail",
"description": "The extension that convert css styles to tailwindcss utility classes",
"version": "0.0.1",
"publisher": "Nafas Ebrahimi",
"version": "1.0.0",
"publisher": "nafasebra",
"engines": {
"vscode": "^1.95.0"
},
"icon": "https://github.com/user-attachments/assets/13620693-e64e-4e56-ad57-276a8199ad54",
"icon": "./assets/csstail-icon.png",
"activationEvents": [],
"categories": [
"Other"
Expand Down

0 comments on commit 8473b43

Please sign in to comment.