create-krispya 0.8.0 → 0.10.0

package/README.md

@@ -1,5 +1,8 @@
 # create-krispya
 
+> [!WARNING]
+> I maintain the single-package library and application templates with vanilla. React, R3F and monorepo is currently experimental.
+
 > Full AI generated docs can be found [here](./docs/api.md).
 
 A CLI for scaffolding modern, clutter-free web projects.
@@ -17,14 +20,33 @@ npm create krispya@latest
 
 **Who cares?**
 
-I really hate looking at my repo when there are 20 config files sitting in root. It is noisy and, worst of all, plain ugly. Not only do we derserve beautiful code, but in the post-AI world great taste is all I have. In pursuit of minimalism, as many files as possible are moved to hidden directories such as `.config` and`.vscode`.
+I really hate looking at my repo when there are 20 config files sitting in root. It is noisy and, worst of all, simply ugly. Not only do we derserve beautiful code, but in the post-AI world great taste is all we have. In pursuit of minimalism, as many files as possible are moved to hidden directories such as `.config` and`.vscode`.
 
-We are also in a time of rampant changes to the JS toolchain ecossytem. In an effort to keep up, but also encourage trying new tools out, I wante to build a framework that let me swap between them with some guardrails.
+We are also in a time of rampant changes to the JS toolchain ecosytem. In an effort to keep up, but also encourage trying new tools out, I wanted to build a framework that let me swap between them with some guardrails.
 
-**Current Status**
+## Single-project workspaces
 
-Consider this experimental but safe. It was vibe coded and then I decided this project deserved better so I am going through it piece by piece and making it whole and loved.
+The basic dish. The default templates include:
 
-## Single-project workspaces
+- **Application.** An application with a dev server.
+- **Library.** A library meant to be published.
+
+## CLI
+
+```bash
+npm create krispya@latest my-project
+# Updates the install with the latest config
+npm create krispya@latest --update
+```
+
+## Why?
+
+### Editor config
+
+Editors, or IDEs, allow the user to generically configure formatting using the [EditorConfig](https://spec.editorconfig.org/) file. You might think, isn't this what the formatter is for? The formatter only runs after code is written while the editor config will enforce the rules inside the editor itself making generated code more consistent and working between editors a nicer experience.
+
+Editor specific config files can optionally be installed for more control. Currently only `vscode` is supported.
+
+### `typecheck` script uses build mode
 
-The basic dish.
+It turns out that for `tsc` to actually follow tsconfig references, it needs to be in [build mode](https://www.typescriptlang.org/docs/handbook/project-references.html#build-mode-for-typescript). This makes it so you can have a (single config entry point)[https://www.typescriptlang.org/docs/handbook/project-references.html#overall-structure], reducing files and making me happy.