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.

Sign up for GitHub

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.md #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 28 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.