Update README.md

README.md

@@ -1,103 +1,71 @@
-# TSDX User Guide
+# @toddledev/tailwind-parser
 
-Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.
+A lightweight library for parsing Tailwind CSS classes and converting HTML with Tailwind classes to a custom node tree structure.
 
-> This TSDX setup is meant for developing libraries (not apps!) that can be published to NPM. If you’re looking to build a Node app, you could use `ts-node-dev`, plain `ts-node`, or simple `tsc`.
-
-> If you’re new to TypeScript, checkout [this handy cheatsheet](https://devhints.io/typescript)
-
-## Commands
-
-TSDX scaffolds your new library inside `/src`.
-
-To run TSDX, use:
+## Installation
 
 ```bash
-npm start # or yarn start
+npm install @toddledev/tailwind-parser
 ```
 
-This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
-
-To do a one-off build, use `npm run build` or `yarn build`.
-
-To run tests, use `npm test` or `yarn test`.
-
-## Configuration
-
-Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
-
-### Jest
+or
 
-Jest tests are set up to run with `npm test` or `yarn test`.
-
-### Bundle Analysis
-
-[`size-limit`](https://github.com/ai/size-limit) is set up to calculate the real cost of your library with `npm run size` and visualize the bundle with `npm run analyze`.
-
-#### Setup Files
-
-This is the folder structure we set up for you:
-
-```txt
-/src
-  index.tsx       # EDIT THIS
-/test
-  blah.test.tsx   # EDIT THIS
-.gitignore
-package.json
-README.md         # EDIT THIS
-tsconfig.json
+```bash
+yarn add @toddledev/tailwind-parser
 ```
 
-### Rollup
+## Usage
 
-TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
+### Parsing Tailwind Classes
 
-### TypeScript
+```javascript
+import { parseClassString } from '@toddledev/tailwind-parser';
 
-`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
+const classString = 'bg-blue-500 hover:bg-blue-600 p-4';
+const { style, variants } = parseClassString(classString);
 
-## Continuous Integration
+console.log(style);    // Object containing parsed styles
+console.log(variants); // Array of parsed variants
+```
 
-### GitHub Actions
+### Converting HTML to Node Tree
 
-Two actions are added by default:
+```javascript
+import { tailwindToToddle } from '@toddledev/tailwind-parser';
 
-- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
-- `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit)
+const html = '<div class="bg-red-500 p-4"><span class="text-white">Hello, World!</span></div>';
+const nodeTree = tailwindToToddle(html);
 
-## Optimizations
+console.log(nodeTree);
+```
 
-Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:
+## API
 
-```js
-// ./types/index.d.ts
-declare var __DEV__: boolean;
+### `parseClassString(classString: string): { style: Record<string, string>, variants: Variant[] }`
 
-// inside your code...
-if (__DEV__) {
-  console.log('foo');
-}
-```
+Parses a string of Tailwind CSS classes and returns an object containing the parsed styles and variants.
 
-You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.
+### `tailwindToToddle(html: string): NodeTree`
 
-## Module Formats
+Converts an HTML string with Tailwind classes to a custom node tree structure.
 
-CJS, ESModules, and UMD module formats are supported.
+## Types
 
-The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.
+The library exports the following types:
 
-## Named Exports
+- `Variant`
+- `NodeTree`
+- `ElementNode`
+- `TextNode`
 
-Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.
+## License
 
-## Including Styles
+[MIT License](LICENSE)
 
-There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.
+## Contributing
 
-For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.
+Contributions are welcome! Please feel free to submit a Pull Request.
 
-## Publishing to NPM
+## Issues
 
-We recommend using [np](https://github.com/sindresorhus/np).
+If you find any bugs or have feature requests, please create an issue on the [GitHub repository](https://github.com/toddledev/tailwind-parser/issues).