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
Minimal README template from https://www.makeareadme.com/
Raw
minimal-readme-template.md

Foobar

Foobar is a Python library for dealing with word pluralization.

Installation

Use the package manager pip to install foobar.

pip install foobar

Usage

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment