Skip to content

Instantly share code, notes, and snippets.

@vporoshok

vporoshok/README.md

Last active October 12, 2021 12:58
Show Gist options
  • Save vporoshok/24d584cb7b52e56f77d9b91d890c3b4c to your computer and use it in GitHub Desktop.
Save vporoshok/24d584cb7b52e56f77d9b91d890c3b4c to your computer and use it in GitHub Desktop.
Download ZIP
Snippet of README file
Raw
README.md

project

Travis Build Go Report Card GoDoc codecov MIT License

One-line summary

Description (what it is). Background, terms, and abstractions.

Motivation

Why I do this project?

Philosophy

Perhaps this project is a reflection of some idea or philosophy.

Usage

Common usage case of this project in a short snippet.
It shouldn't contain all the features of the project.
Short is better than full.

How it works

Architect, conceptions, dependencies. This section should be written after implementation.

Key features

List of features that may help to decide use this project.

See also

List of inspiration projects, alternatives, and analogs. Maybe some comparisons if it's important.

Roadmap

Features to do.

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