Skip to content

Instantly share code, notes, and snippets.

@sophiabrandt

sophiabrandt/minimal-readme-template.md

Created March 29, 2020 07:30
Show Gist options
  • Save sophiabrandt/0c68c821631e4203415f85043e29749f to your computer and use it in GitHub Desktop.
Save sophiabrandt/0c68c821631e4203415f85043e29749f to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. sophiabrandt created this gist Mar 29, 2020.
    29 changes: 29 additions & 0 deletions minimal-readme-template.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,29 @@
    # Foobar

    Foobar is a Python library for dealing with word pluralization.

    ## Installation

    Use the package manager [pip](https://pip.pypa.io/en/stable/) to install foobar.

    ```bash
    pip install foobar
    ```

    ## Usage

    ```python
    import foobar

    foobar.pluralize('word') # returns 'words'
    foobar.pluralize('goose') # returns 'geese'
    foobar.singularize('phenomena') # returns 'phenomenon'
    ```

    ## Contributing
    Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

    Please make sure to update tests as appropriate.

    ## License
    [MIT](https://choosealicense.com/licenses/mit/)