diff --git a/README.md b/README.md index 152cdcd..4f2e61a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,39 @@ # @e18e/cli -This is currently a very early work in progress repository for tracking -the new [e18e](https://e18e.dev) CLI. +![hero](./public/banner.png) -**Nothing usable exists here yet.** +The e18e CLI is a tool for analyzing and optimizing your JS/TS projects. It helps you identify performance issues, find optimization opportunities, and automatically migrate to suggested dependencies. + +> [!IMPORTANT] +> This project is still in early development and we are actively working on it. If you encounter any issues or have ideas for new features, please let us know by [opening an issue](https://github.com/e18e/cli/issues/new/choose) on our GitHub repository. +> + +## Quick Start + +```sh +// Install and run analysis +npx @e18e/cli analyze + +// Migrate packages interactively +npx @e18e/cli migrate --interactive +``` + +## Installation + +You can install the e18e CLI globablly or use it with npx: + +```sh +npm install -g @e18e/cli +``` + +## Learn more + +You can learn more about the CLI by going through the [documentation](https://e18e.dev/docs/cli/). + +## Contributing + +We're happy you'd like to get involved! Please join our [Discord](https://chat.e18e.dev) server to discuss with others. ## License -MIT +MIT License @2025 - Present e18e contributors. diff --git a/public/banner.png b/public/banner.png new file mode 100644 index 0000000..4bc38ee Binary files /dev/null and b/public/banner.png differ