Skip to content

Instantly share code, notes, and snippets.

@nicolezimerman

nicolezimerman/readme-template.md

Created December 21, 2020 22:04
Show Gist options
  • Save nicolezimerman/8359f343d05bb4d9bdfbddbdc0fe93b0 to your computer and use it in GitHub Desktop.
Save nicolezimerman/8359f343d05bb4d9bdfbddbdc0fe93b0 to your computer and use it in GitHub Desktop.
Download ZIP
Readme template
Raw
readme-template.md

✨ NAME (badges status of project) Status

Description

🎨 Preview

Visual preview / demo url

📄 Documentation

link to documentation

💻 Technology

🚀 Installation

Instalation instructions 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.

⏳ To do / WIP

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