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

Update documentation #2

Open
mwebb387 opened this issue Aug 29, 2022 · 0 comments
Open

Update documentation #2

mwebb387 opened this issue Aug 29, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@mwebb387
Copy link

Description of the new feature / enhancement

We should update the documentation. As part of updating it, we should include the following:

  • Links to other NPM dependencies
  • Full configuration example
  • Better / updated formatting
  • Image / gif (this should not be hosted in the repo directly, but in GitHub, potentially attached to this issue)

Scenario when this would be used?

No response

Supporting information

No response
@mwebb387 mwebb387 added the enhancement New feature or request label Aug 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mwebb387