From 51496bf8a3e4685e5739ca4f8101e120d32adcaf Mon Sep 17 00:00:00 2001
From: Jannis Morgenstern <jannis.n.morgenstern@gmail.com>
Date: Mon, 4 Mar 2024 15:44:57 +0100
Subject: [PATCH] docs: dir restructure & development guide

---
 CONTRIBUTING.md                               | 24 +++++++++++++++++++
 .../css2tailwind => css2tailwind}/.npmignore  |  0
 .../.prettierignore                           |  0
 .../CHANGELOG.md                              |  0
 .../css2tailwind => css2tailwind}/README.md   |  0
 .../eslint.config.js                          |  0
 .../package.json                              |  0
 .../css2tailwind => css2tailwind}/src/bin.cjs |  0
 .../src/build.ts                              |  0
 .../css2tailwind => css2tailwind}/src/cli.ts  |  0
 .../src/compiler.ts                           |  0
 .../src/error.ts                              |  0
 .../css2tailwind => css2tailwind}/src/util.ts |  0
 .../tsconfig.json                             |  0
 .../tsup.config.ts                            |  0
 pnpm-workspace.yaml                           |  2 +-
 16 files changed, 25 insertions(+), 1 deletion(-)
 rename {packages/css2tailwind => css2tailwind}/.npmignore (100%)
 rename {packages/css2tailwind => css2tailwind}/.prettierignore (100%)
 rename {packages/css2tailwind => css2tailwind}/CHANGELOG.md (100%)
 rename {packages/css2tailwind => css2tailwind}/README.md (100%)
 rename {packages/css2tailwind => css2tailwind}/eslint.config.js (100%)
 rename {packages/css2tailwind => css2tailwind}/package.json (100%)
 rename {packages/css2tailwind => css2tailwind}/src/bin.cjs (100%)
 rename {packages/css2tailwind => css2tailwind}/src/build.ts (100%)
 rename {packages/css2tailwind => css2tailwind}/src/cli.ts (100%)
 rename {packages/css2tailwind => css2tailwind}/src/compiler.ts (100%)
 rename {packages/css2tailwind => css2tailwind}/src/error.ts (100%)
 rename {packages/css2tailwind => css2tailwind}/src/util.ts (100%)
 rename {packages/css2tailwind => css2tailwind}/tsconfig.json (100%)
 rename {packages/css2tailwind => css2tailwind}/tsup.config.ts (100%)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5e1989b..34be79a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -12,3 +12,27 @@ Install dependencies:
 ```sh
 pnpm i
 ```
+
+## Architecture
+
+This repository is a _monorepo_ powered by [pnpm workspaces](https://pnpm.io/workspaces) & [Turborepo](https://turbo.build/repo/docs).
+
+You can find the different _projects_ in the directories:
+
+- [./examples](./examples)
+  - [./examples/standalone](./examples/standalone) contains an example for using `css2tailwind` in a single repository
+- [./css2tailwind](./css2tailwind) contains the source code for the `css2tailwind` tool
+
+## Developing
+
+After making changes in [./css2tailwind](./css2tailwind), you must build the CLI.
+
+```sh
+pnpm -F @titanom/css2tailwind build
+```
+
+Then you can use it with any of the examples, e.g. with `standalone`.
+
+```sh
+pnpm -F @css2tw/standalone dev
+```
diff --git a/packages/css2tailwind/.npmignore b/css2tailwind/.npmignore
similarity index 100%
rename from packages/css2tailwind/.npmignore
rename to css2tailwind/.npmignore
diff --git a/packages/css2tailwind/.prettierignore b/css2tailwind/.prettierignore
similarity index 100%
rename from packages/css2tailwind/.prettierignore
rename to css2tailwind/.prettierignore
diff --git a/packages/css2tailwind/CHANGELOG.md b/css2tailwind/CHANGELOG.md
similarity index 100%
rename from packages/css2tailwind/CHANGELOG.md
rename to css2tailwind/CHANGELOG.md
diff --git a/packages/css2tailwind/README.md b/css2tailwind/README.md
similarity index 100%
rename from packages/css2tailwind/README.md
rename to css2tailwind/README.md
diff --git a/packages/css2tailwind/eslint.config.js b/css2tailwind/eslint.config.js
similarity index 100%
rename from packages/css2tailwind/eslint.config.js
rename to css2tailwind/eslint.config.js
diff --git a/packages/css2tailwind/package.json b/css2tailwind/package.json
similarity index 100%
rename from packages/css2tailwind/package.json
rename to css2tailwind/package.json
diff --git a/packages/css2tailwind/src/bin.cjs b/css2tailwind/src/bin.cjs
similarity index 100%
rename from packages/css2tailwind/src/bin.cjs
rename to css2tailwind/src/bin.cjs
diff --git a/packages/css2tailwind/src/build.ts b/css2tailwind/src/build.ts
similarity index 100%
rename from packages/css2tailwind/src/build.ts
rename to css2tailwind/src/build.ts
diff --git a/packages/css2tailwind/src/cli.ts b/css2tailwind/src/cli.ts
similarity index 100%
rename from packages/css2tailwind/src/cli.ts
rename to css2tailwind/src/cli.ts
diff --git a/packages/css2tailwind/src/compiler.ts b/css2tailwind/src/compiler.ts
similarity index 100%
rename from packages/css2tailwind/src/compiler.ts
rename to css2tailwind/src/compiler.ts
diff --git a/packages/css2tailwind/src/error.ts b/css2tailwind/src/error.ts
similarity index 100%
rename from packages/css2tailwind/src/error.ts
rename to css2tailwind/src/error.ts
diff --git a/packages/css2tailwind/src/util.ts b/css2tailwind/src/util.ts
similarity index 100%
rename from packages/css2tailwind/src/util.ts
rename to css2tailwind/src/util.ts
diff --git a/packages/css2tailwind/tsconfig.json b/css2tailwind/tsconfig.json
similarity index 100%
rename from packages/css2tailwind/tsconfig.json
rename to css2tailwind/tsconfig.json
diff --git a/packages/css2tailwind/tsup.config.ts b/css2tailwind/tsup.config.ts
similarity index 100%
rename from packages/css2tailwind/tsup.config.ts
rename to css2tailwind/tsup.config.ts
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
index c949490..0346efc 100644
--- a/pnpm-workspace.yaml
+++ b/pnpm-workspace.yaml
@@ -1,3 +1,3 @@
 packages:
   - 'examples/*'
-  - 'packages/*'
+  - 'css2tailwind'