diff --git a/README.md b/README.md index d1e06e3..1bad510 100644 --- a/README.md +++ b/README.md @@ -34,15 +34,33 @@ License ---- MIT +# Foobar -## Made with <3 -### Mohammed Farhan -##### www.twitter.com/farhankn +Foobar is a Python library for dealing with word pluralization. -**Free Software, Hell Yeah!** +## Installation -[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax) +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. - [Twitter Bootstrap]: +## License +[MIT](https://choosealicense.com/licenses/mit/)