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.

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

Tidy up readme/ext description #242

Merged
merged 1 commit into from
Mar 17, 2021
Merged

Tidy up readme/ext description #242

merged 1 commit into from
Mar 17, 2021

Conversation

Tyriar
Copy link
Member

@Tyriar Tyriar commented Mar 17, 2021

Changes/justification:

  • Removed header from top of readme as it re-states the title when viewing the
    extension in marketplace/vscode
  • Moved code of conduct to CODE_OF_CONDUCT.md, it's not relevant to people using
    the extension
  • Various wording improvements, made some sections more concise and removed
    details that weren't important (eg. navigating/scrolling support)
  • Moved easiest how to use steps to the top of the list
  • Removed the contributed settings section as it repeats the contribution tab
    within vscode

Fixes #221

Changes/justification:
- Removed header from top of readme as it re-states the title when viewing the
extension in marketplace/vscode
- Moved code of conduct to CODE_OF_CONDUCT.md, it's not relevant to people using
the extension
- Various wording improvements, made some sections more concise and removed
details that weren't important (eg. navigating/scrolling support)
- Moved easiest how to use steps to the top of the list
- Removed the contributed settings section as it repeats the contribution tab
within vscode

Fixes #221
@Tyriar Tyriar added this to the March 2021 milestone Mar 17, 2021
@Tyriar Tyriar requested a review from lramos15 March 17, 2021 13:11
@Tyriar Tyriar self-assigned this Mar 17, 2021
@lramos15 lramos15 merged commit 9a61cfd into main Mar 17, 2021
@Tyriar Tyriar deleted the tyriar/readme branch March 17, 2021 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use consistent language in readme
2 participants