From 0d6d546f742fd262bc13d17f1935a401de24e236 Mon Sep 17 00:00:00 2001 From: Benjamin Wiederkehr Date: Tue, 27 Aug 2019 14:56:52 +0200 Subject: [PATCH] Update README.md --- README.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 533e743..3f76957 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,28 @@ -# open-source-templates -A collection of template files for open source projects. +# Title of _Software_ + +A short description of what the _software_ does. + +## Installation + +A brief instruction of how the _software_ can be installed on a computer. + +```bash +pip install software +``` + +## Usage + +A brief instruction of how the _software_ is to be used once installed. + +```python +import software + +software.pluralize('word') # returns 'words' +software.singularize('phenomena') # returns 'phenomenon' +``` + +## Contributing +An explanation how the author would like to handle contributions and how a user will be able to contribute back to the _software_. + +## License +A list of the license under which the _software_ has been released linked to the full license text.