Improve README #196
Merged
Improve README #196
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
rmarescu
commented
Dec 28, 2024
There was a problem hiding this comment.
4 top-level sections:
- Features
- Using Shortest in your project
- Web app development
- Shortest CLI development
The content is still quite dense, and this is an attempt to improve readability a bit.
I think the audience can be split in 2:
- people looking to use Shortest within their project
- poeple that would like to contribute
With that in mind, I'm thinking of having 3 top-level sections:
- Features
- Using Shortest in your project
- Contributing
- Web app development
- Shortest CLI development
As current focus is on the CLI development, I think the order can be swapped.
| ```bash | ||
| npx shortest # for npm | ||
| pnpm shortest # for pnpm | ||
| yarn shortest # for yarn | ||
| ``` | ||
|
|
||
| ## Quick Start | ||
| ### Quick start |
There was a problem hiding this comment.
Changed to sentence case for headings for consistency with our other projects.
| @@ -194,20 +204,21 @@ vercel link | |||
| vercel env pull | |||
| ``` | |||
|
|
|||
| #### For Other Contributors: | |||
There was a problem hiding this comment.
Removed punctuation from headings.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
README preview
pnpm shortest:devto test the CLI without build