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

Add overview section to the README #71

Open
jakewrfoster opened this issue Apr 17, 2024 · 1 comment
Open

Add overview section to the README #71

jakewrfoster opened this issue Apr 17, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@jakewrfoster
Copy link
Member

Description of the documentation inaccuracy

Within the README, I don't think there is enough information in broad strokes explaining what this plugin is and does and why someone would want to use it. Adding an overview that provides insight and maybe some intrigue could go a long way to encourage adoption and usage both from the larger community and from the Alley community.

Additional Information

No response
@jakewrfoster jakewrfoster added the documentation Improvements or additions to documentation label Apr 17, 2024
@anubisthejackle
Copy link
Contributor

While we're in there, we should fix the broken link at the bottom of the README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jakewrfoster @anubisthejackle