Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dankore committed May 11, 2024
1 parent c96b193 commit 79831c8
Showing 1 changed file with 33 additions and 6 deletions.
39 changes: 33 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
# Built with Tailwind CSS
# **Built with Tailwind CSS**

![Logo](/logo-with-text.png)

## Important Links

1. [GitHub Repository](https://github.com/dankore/built-with-tailwind-css)
2. [Documentation](https://dankore.github.io/built-with-tailwind-css)
**Built with Tailwind CSS** is a Chrome Extension that enhances your development workflow by identifying the usage of Tailwind CSS on any webpage. This tool is designed for web developers, designers, and enthusiasts who want to understand how Tailwind CSS is implemented across various sites.

## About
**Features:**

Built with Tailwind CSS is a Chrome Extension that identifies the usage of Tailwind CSS in web pages.
**Automatic Detection**: Discover instantly if a website is using Tailwind CSS as soon as you navigate to it. The extension analyses both external stylesheets and inline styles.

**Version Identification**: Not only does the extension detect the presence of Tailwind CSS, but it also determines the specific version used, helping you understand which features and utilities are likely employed.

**Badge Display**: A badge on the extension icon provides quick information about the detected Tailwind CSS version, or it remains blank if Tailwind CSS isn’t found.

**Efficient Caching**: Results are cached per domain to optimize performance and minimize redundant checks, ensuring swift browsing without repetitive processing.

**Easy Access**: Use the popup to get a summary of the detection results and access settings to customize the extension's behavior.

**Theme Support**: Toggle between light and dark themes for the extension’s popup window, aligning with your preferred visual style.

## How It Works

Expand All @@ -29,3 +37,22 @@ Contributions are welcome! Feel free to submit pull requests with any enhancemen
GitHub Repository: [https://github.com/dankore/built-with-tailwind-css](https://github.com/dankore/built-with-tailwind-css)

Documentation: [https://dankore.github.io/built-with-tailwind-css](https://dankore.github.io/built-with-tailwind-css)


**Privacy & Security:**

Your privacy is paramount. **Built with Tailwind CSS** operates entirely locally, with no data sent over the Internet or stored on external servers. The extension does not track your browsing activity or access any data other than CSS class information.

**Permissions:**

- **Read and Change Data on Websites**: Necessary for detecting Tailwind CSS in styles applied to the web pages you visit.
- **Alarms**: Used for managing periodic cache resets.
- **Tabs & Scripting**: Essential for executing content scripts that check for Tailwind CSS and communicating with tabs.

**What's New:**

- Enhanced detection algorithms for pinpoint accuracy.
- Added support for latest Tailwind CSS versions.
- Improved performance with optimized caching mechanism.
- Updated UI for the popup with theme toggle support.

0 comments on commit 79831c8

Please sign in to comment.