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

Update Documentation #7

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

lmdulick
Copy link

Documentation-only update regarding aesthetic of README doc, "How-To," and warnings.

@lmdulick
Copy link
Author

A note about the proposed changes:

  • The inclusion of two asterisks (** [word] **) on either side of a word (ex. The Movie Database) bolds that word within the paragraph, improving the overall readability of the README and emphasizing certain important words to the reader.
  • The shell feature allows a user to simply click the copy icon for a command, rather than requiring the user to highlight and copy the command themselves. For Example:
This is a command.
  • Finally, three hashtags (###) makes a subheading, improving the grouping and overall readability of the README. For Example:

Heading

Subheading

Sub-Subheading

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.

1 participant