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

Rework README.md #12

Merged
merged 1 commit into from
Aug 11, 2023
Merged

Rework README.md #12

merged 1 commit into from
Aug 11, 2023

Conversation

t-mart
Copy link
Contributor

@t-mart t-mart commented Aug 10, 2023

This PR reworks the README.md file. I just used this template for my own bucket, and saw some areas that could be improved:

  • Reorder the sections, putting the "How do I use this template?" first. This is the first way you'll interact with this template.
  • Provide step-by-step instructions to using the template, elaborating in certain areas. Specifically, instruct how to set the GitHub Actions write permission (see [Bug]: Excavator action fails due to permisisons #8).
  • Show app installation commands in a way similar to how https://scoop.sh does.
  • Reference the App Manifests wiki page too, which includes detail about manifest keys.
  • Use consistent markdown heading syntax (get rid of the underline style).

Closes #8

@rashil2000 rashil2000 merged commit eeeafd1 into ScoopInstaller:master Aug 11, 2023
3 checks passed
@t-mart t-mart deleted the update-readme branch August 11, 2023 15:34
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.

[Bug]: Excavator action fails due to permisisons
4 participants