New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add good intro to `README.md` #34

Open

4 tasks

ai opened this issue Sep 8, 2023 · 0 comments

Member

ai commented Sep 8, 2023

Good intro to docs is the key to open source project promotion. We should add it after adding good styling out-of-the-box.

Check out my slides about open source promotion
Add screenshot which will explain tool only by image (TypeDoc example in a classic Starlight design)
Improve the first sentence which describe the tool
Add npm install and other simple steps to install the tool

The text was updated successfully, but these errors were encountered:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment