diff --git a/README.md b/README.md index 4e23dbf04..8fd7c9c4b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@
- [Experimental] Monorepo for Flint: a fast, friendly linter. + [Experimental] A fast, friendly linter for JavaScript, TypeScript, and more. ❤️🔥
@@ -19,36 +19,21 @@
-**Flint** is an experimental new linter.
-It's a proof-of-concept to explore the concepts in the following blog posts:
+**Flint** is an experimental new _"hybrid"_ linter: one that combines...
-- [Hybrid Linters: The Best of Both Worlds](https://www.joshuakgoldberg.com/blog/hybrid-linters-the-best-of-both-worlds)
-- [If I Wrote a Linter, Part 1: Architecture](https://www.joshuakgoldberg.com/blog/if-i-wrote-a-linter-part-1-architecture)
-- [If I Wrote a Linter, Part 2: Developer Experience](https://www.joshuakgoldberg.com/blog/if-i-wrote-a-linter-part-2-developer-experience)
-- [If I Wrote a Linter, Part 3: Ecosystem](https://www.joshuakgoldberg.com/blog/if-i-wrote-a-linter-part-3-ecosystem)
-- [If I Wrote a Linter, Part 4: Summary](https://www.joshuakgoldberg.com/blog/if-i-wrote-a-linter-part-4-summary)
+- 😌 **Ergonomics**: the ease of writing rules in JavaScript or TypeScript
+- ⚡️ **Performance**: much of the speed of native linters with intelligent caching and native code for bottlenecking operations
-This project might go nowhere.
-It might show some of those ideas to be wrong.
-It might become a real linter.
-Only time will tell.
-
-In the meantime, come talk about it on the [Flint Discord](https://flint.fyi/discord).
-
-👉 See [flint.fyi](https://flint.fyi) for additional documentation.
-
-## Why?
-
-Flint is an attempt at a "hybrid" linter: one that combines...
+It also brings in several improvements over traditional linter paradigms:
-- **Ergonomics**: the ease of writing rules in JavaScript or TypeScript
-- **Performance**: some of the speed of native linters by parsing and type checking with typescript-go
+- Streamlined configuration: flexible configuration files that still preserve readability
+- Type-aware caching: significantly improving performance when linting changes to large repositories
+- Unified core: promoting popular rules to the core project for easier, more reliable inclusion
-It also brings in several improvements over traditional linter paradigms:
+For deep dives into Flint, see:
-- **Streamlined configuration**: flexible configuration files that still preserve readability
-- **Type-aware caching**: significantly improving performance when linting changes to large repositories
-- **Unified core**: promoting popular rules to the core project for easier, more reliable inclusion
+- **[Introducing Flint](https://www.flint.fyi/blog/introducing-flint)**: the core hypotheses Flint is testing out, with why we hope they succeed.
+- **[What Flint Does Differently](https://www.flint.fyi/blog/what-flint-does-differently)**: a full list of the core, developer, and end-user design differences in Flint compared to other linters.
## Usage
diff --git a/cspell.json b/cspell.json
index bf70eaf4d..b4ff0c02c 100644
--- a/cspell.json
+++ b/cspell.json
@@ -42,6 +42,7 @@
"barrymichaeldoyle",
"bday",
"BDFL",
+ "bottlenecking",
"bradzacher",
"codegen",
"codemod",