diff --git a/README.md b/README.md index 709b9bc..8204518 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# rules +# rules 🧩 -> **tl;dr:** `npm i -g rules-cli` then `rules add starter/nextjs-rules` +> **tl;dr:** 🚀 `npm i -g rules-cli` then `rules add starter/nextjs-rules` `rules` is a CLI built for managing rules across any AI developer tool. Rules are markdown files that encode workflows, preferences, tech stack details, and more in plain natural language so you can get better help from LLMs. -## Install `rules` +## Install `rules` 📦 The `rules` CLI can be installed using NPM: @@ -12,7 +12,7 @@ The `rules` CLI can be installed using NPM: npm i -g rules-cli ``` -## Add rules +## Add rules ➕ To download rules to your repository you can use `rules add`. For example: @@ -28,7 +28,7 @@ You can also download from GitHub rather than the rules registry: rules add gh:continuedev/rules-template ``` -## Render rules +## Render rules 🖨️ To use rules with your AI code assistant of choice, you can "render" them to the necessary format and location using `rules render`. For example, @@ -38,7 +38,7 @@ rules render cursor will copy all of the `.rules/` into a `.cursor/rules/` folder. `rules` currently supports the following formats: cursor, continue, windsurf, claude, copilot, codex, cline, cody, and amp. -## Publish rules +## Publish rules 🚢 To make your rules available to others, you can publish using `rules publish`: @@ -51,7 +51,7 @@ This would make your rule available to download with `rules add ` The command automatically determines the slug from your `rules.json` file. To make sure you have a `rules.json` file in your current directory, use `rules init`. -## Helping users use your rules +## Helping users use your rules 🤝 If you are building a developer tool and want to optimize how AI IDEs work with your tool, `rules` makes it easy to give your users the best experience.