Skip to content
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

chore: refactor readme #663

Merged
merged 4 commits into from
Nov 3, 2023
Merged

chore: refactor readme #663

merged 4 commits into from
Nov 3, 2023

Conversation

ematipico
Copy link
Member

@ematipico ematipico commented Nov 3, 2023 •
edited
Loading

Summary

This PR refactors a bit the README.md of the npm package:

  • it adds installation and usage examples
  • it moves the documentation paragraph up
  • it moves the traits of Biome after the documentation:
    • I removed the part about other tools
    • I added a trait about not needing Node.js to function

Test Plan

Proof read

@ematipico ematipico requested review from a team November 3, 2023 08:04
@nhedger
Copy link
Member

nhedger commented Nov 3, 2023

What about a link to the playground?

@ematipico
Copy link
Member Author

What about a link to the playground?

I don't know how to present it and where. Any suggestion?

@ematipico ematipico merged commit 32d40cf into main Nov 3, 2023
6 checks passed
@ematipico ematipico deleted the refactor/readme branch November 3, 2023 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nhedger nhedger nhedger left review comments

@Conaclos Conaclos Conaclos approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ematipico @nhedger @Conaclos