🚧Improve project README

[CalvinWilkinson]

Complete Items Below

• [X] I have updated the title without removing the 🚧 emoji.

Description

Improve the project's readme so the text in the What's the point? 🤷🏼 section is laid out better. Currently the way that the text is wrapping is making the layout all WONKY and difficult to read. The assumption is that the markdown is setup to force wrap the sentences instead of auto-wrapping the text.

Either way, it does not look great.

💡Use VSCode to view the rendered markdown with the approximately the same width as in the browser in the marketplace, and use this as a guide to layout the text.

Currently On Marketplace:

Convert the action input example values to inline code blocks to emphasize what it should look like. The text to convert are in the purple rectangles in the image below:

Acceptance Criteria

• [x] Section in README changed to lay out text in a better way
• [x] Input value examples converted into markdown inline code blocks
  • This is done by simply adding a single backtick to each end of the text you want to convert to an inline code block.

ToDo Items

• [X] Change type labels added to this issue. Refer to the Change Type Labels section below.
• [X] Priority label added to this issue. Refer to the Priority Type Labels section below.
• [X] Issue linked to the correct project (if required).
• [X] Issue linked to the correct milestone (if required).
• [x] Draft pull request created and linked to this issue (only required with code changes).

Issue Dependencies

No response

Related Work

No response

Additional Information:

Change Type Labels

Change Type	Label
Bug Fixes	https://github.com/KinsonDigital/BranchValidator/labels/%F0%9F%90%9Bbug
Breaking Changes	https://github.com/KinsonDigital/BranchValidator/labels/%F0%9F%A7%A8breaking%20changes
New Feature	https://github.com/KinsonDigital/BranchValidator/labels/%E2%9C%A8new%20feature
Workflow Changes	https://github.com/KinsonDigital/BranchValidator/labels/workflow
Code Doc Changes	https://github.com/KinsonDigital/BranchValidator/labels/%F0%9F%93%91documentation%2Fcode
Product Doc Changes	https://github.com/KinsonDigital/BranchValidator/labels/%F0%9F%93%9Ddocumentation%2Fproduct

Priority Type Labels

Priority Type	Label
Low Priority	https://github.com/KinsonDigital/BranchValidator/labels/low%20priority
Medium Priority	https://github.com/KinsonDigital/BranchValidator/labels/medium%20priority
High Priority	https://github.com/KinsonDigital/BranchValidator/labels/high%20priority

Code of Conduct

• [X] I agree to follow this project's Code of Conduct.

[CalvinWilkinson]

@kselena In the picture above with the purple rectangles, the words Example 1:, Example 2:, etc., do you think those should be italic?

Don't be afraid to come up with some ideas to improve the readability and layout of this document. You can play around with different things in VSCode as well.

[KinsonDigitalAdmin]

@kselena Just a quick heads up. Anytime you change anything that has to do with the product documentation, we need a https://github.com/KinsonDigital/BranchValidator/labels/%F0%9F%93%9Ddocumentation%2Fproduct label.

I went ahead and added one for both the PR and the issue.

It is a little tricky. If I am adding a new method that has code docs, those code docs end up in the API documentation website., but I will not put the https://github.com/KinsonDigital/BranchValidator/labels/%F0%9F%93%9Ddocumentation%2Fproduct on that issue. The reason is that the https://github.com/KinsonDigital/BranchValidator/labels/%F0%9F%93%9Ddocumentation%2Fproduct is meant only for documentation changes without changes to the original code base.

For example, if I had an issue to ONLY changing the code docs, then that would take the https://github.com/KinsonDigital/BranchValidator/labels/%F0%9F%93%9Ddocumentation%2Fproduct label.