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

Revised README.md #4

Merged
merged 1 commit into from
Jul 2, 2024
Merged

Revised README.md #4

merged 1 commit into from
Jul 2, 2024

Conversation

tomwheeler
Copy link
Collaborator

What was changed

I revised the README to provide a little more depth, include a link to the pnpm command, and made it clear that the other repo will be the main source of documentation about the OMS.

Why?

  1. The pnpm commands by themselves aren't enough to successfully run the application, so I included a link to the QuickStart instructions in the other repo since they explain the prerequisite steps.
  2. I suspect that some users may not have the pnpm command installed and may not know where to download it, so I included a link to that site.
  3. I clarified that the other repo will provide detailed documentation on the project and that what's here is minimal and applies specifically to the web app.
  4. I added a mention of the CI/CD for this project since it seemed relevant to the "Building" heading.

I revised the README to provide a little more depth, include a link to the pnpm command (in case the user didn't have it installed), and made it clear that the other repo will be the main source of documentation about the OMS.
@tomwheeler tomwheeler merged commit 782e1ce into main Jul 2, 2024
3 checks passed
@tomwheeler tomwheeler deleted the tw-revise-readme branch July 2, 2024 21:43
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.

2 participants