Skip to content

Commit 03c074e

Browse files
authored
docs(readme): update README and add banner (#113)
1 parent 575a731 commit 03c074e

File tree

2 files changed

+33
-4
lines changed

2 files changed

+33
-4
lines changed

README.md

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,39 @@
11
# @e18e/cli
22

3-
This is currently a very early work in progress repository for tracking
4-
the new [e18e](https://e18e.dev) CLI.
3+
![hero](./public/banner.png)
54

6-
**Nothing usable exists here yet.**
5+
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.
6+
7+
> [!IMPORTANT]
8+
> 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.
9+
>
10+
11+
## Quick Start
12+
13+
```sh
14+
// Install and run analysis
15+
npx @e18e/cli analyze
16+
17+
// Migrate packages interactively
18+
npx @e18e/cli migrate --interactive
19+
```
20+
21+
## Installation
22+
23+
You can install the e18e CLI globablly or use it with npx:
24+
25+
```sh
26+
npm install -g @e18e/cli
27+
```
28+
29+
## Learn more
30+
31+
You can learn more about the CLI by going through the [documentation](https://e18e.dev/docs/cli/).
32+
33+
## Contributing
34+
35+
We're happy you'd like to get involved! Please join our [Discord](https://chat.e18e.dev) server to discuss with others.
736

837
## License
938

10-
MIT
39+
MIT License @2025 - Present e18e contributors.

public/banner.png

86.1 KB
Loading

0 commit comments

Comments
 (0)