@enhance-eng/archangel 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,27 @@
-# Temporary Holding Version
+# Archangel
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**Make architecture verifiable.**
+
+Archangel checks the architecture rules of a TypeScript codebase. You write down how your code is
+organized. Archangel tells you when the code breaks those rules, and what to do about it. It checks
+a large repository in about a second, so it can run in your editor as you type.
+
+```sh
+npm install --save-dev @enhance-eng/archangel
+npx archangel init --typescript
+npx archangel check
+```
+
+Archangel checks imports, import cycles, file and folder names, the files that folders must contain,
+and exports. It has presets for Feature-Sliced Design and Next.js, and you can write your own
+conditions in TypeScript.
+
+- [Quick start](https://github.com/enhance-labs-builds/archangel/blob/main/README.md#quick-start)
+- [Rules](https://github.com/enhance-labs-builds/archangel/blob/main/docs/rules.md)
+- [Presets](https://github.com/enhance-labs-builds/archangel/blob/main/docs/presets.md)
+- [Plugins](https://github.com/enhance-labs-builds/archangel/blob/main/docs/plugins.md)
+- [Commands](https://github.com/enhance-labs-builds/archangel/blob/main/docs/commands.md)
+
+The package includes a prebuilt binary for macOS, Linux and Windows. You do not need Rust.
+
+Licensed under MIT or Apache-2.0, at your option.