Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
atakantepe committed May 22, 2024
1 parent 07baa01 commit 476929e
Showing 1 changed file with 55 additions and 3 deletions.
58 changes: 55 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,67 @@
# Tailwind Cheat Sheet

This project is currently in the initiation phase and does not have any released versions yet. It aims to provide a user friendly Tailwind CSS cheat sheet using React and Vite.
Welcome to the Tailwind CSS Cheat Sheet! This project aims to provide a user-friendly Tailwind CSS cheat sheet using React and Vite.

### Version 0.1.0

You can view the live version at [atakantepe.com/tailwind-cheat-sheet](https://atakantepe.com/tailwind-cheat-sheet).

## Tailwind CSS Parser

This project utilizes the [Tailwind CSS Parser](https://github.com/atakantepe/tailwindcss-parser) that I built.
This project utilizes the [Tailwind CSS Parser](https://github.com/atakantepe/tailwindcss-parser) that I built. The parser helps in extracting and organizing Tailwind CSS classes for easy reference.

## Getting Started

To run the project locally, follow these steps:

1. **Clone the repository**
```sh
git clone https://github.com/atakantepe/tailwind-cheat-sheet.git
cd tailwind-cheat-sheet
```

2. **Install dependencies**
```sh
npm install
```

3. **Run the development server**
```sh
npm run dev
```

Your development server should now be running at `http://localhost:3000`.

## Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
Contributions are welcome! Here’s how you can contribute:

1. **Fork the repository**: Click the "Fork" button at the top of this page.
2. **Clone your fork**:
```sh
git clone https://github.com/your-username/tailwind-cheat-sheet.git
cd tailwind-cheat-sheet
```

3. **Create a branch**:
```sh
git checkout -b feature/YourFeatureName
```

4. **Make your changes**: Implement your feature or fix.
5. **Commit your changes**:
```sh
git add .
git commit -m 'Add some feature'
```

6. **Push to the branch**:
```sh
git push origin feature/YourFeatureName
```

7. **Open a Pull Request**: Navigate to your fork on GitHub and click the "New Pull Request" button.

### Issues

If you encounter any issues or have suggestions for improvements, please open an issue on GitHub.

0 comments on commit 476929e

Please sign in to comment.