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 README and add PyPI badge [skip ci] #57

Merged
merged 1 commit into from
Jan 11, 2022

Conversation

mbrukman
Copy link
Collaborator

Global changes:

  • use leading # to specify heading level rather than underlines; it's easier
    to manage and does not require an extra line or keeping the underline matching
    the length of the heading

Initial section:

  • update title to be "ipycache" instead of description, since it's already in
    the first line of the README
  • add badge displaying the latest PyPI version and linking to PyPI

Installation section:

  • put installation commands into separate block commands rather than inline code

Examples section:

  • link to all 3 notebooks in the examples directory
  • link to notebooks using relative links, since GitHub can now render notebooks

Usage section:

  • remove bullet points in "Usage" section, since every paragraph was its own
    bullet, and it's not really a list anyway, so it's less readable this way
  • replace tabs with spaces for indentation of code

Global changes:

* use leading `#` to specify heading level rather than underlines; it's easier
  to manage and does not require an extra line or keeping the underline matching
  the length of the heading

Initial section:

* update title to be "ipycache" instead of description, since it's already in
  the first line of the README
* add badge displaying the latest PyPI version and linking to PyPI

Installation section:

* put installation commands into separate block commands rather than inline code

Examples section:

* link to all 3 notebooks in the `examples` directory
* link to notebooks using relative links, since GitHub can now render notebooks

Usage section:

* remove bullet points in "Usage" section, since every paragraph was its own
  bullet, and it's not really a list anyway, so it's less readable this way
* replace tabs with spaces for indentation of code
@mbrukman mbrukman requested a review from rossant January 11, 2022 03:43
@mbrukman
Copy link
Collaborator Author

@rossant — I know you said I should feel free to merge my own PRs, but since I'm changing what is the public image of this project's repo (the README), including changing the title, I figured you might want to take a look at this before I merge it, since it goes live immediately.

@mbrukman mbrukman merged commit 6df7dbf into rossant:master Jan 11, 2022
@mbrukman mbrukman deleted the update-readme-format branch January 11, 2022 16:04
@mbrukman mbrukman added this to the Release 0.1.5 milestone Jan 18, 2022
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