readme

examples of readme generator using gomplate.

Requirements

This is a list of requirements that need to be installed previously to enjoy all the goodies of this configuration:

• gomplate
• docker
• python
• taskfile

Usage

Example can be found in example folder.

  task setup

Examples

common

Copyrights

# copyrights to this project
copyrights:
  - name: 'hadenlabs'
    url: 'https://hadenlabs.com'
    year: '2018'

TO-DO

todo:
  - name: 'chore: implement features'
    url: 'https://github.com/hadenlabs/readme/issues/4'

Features

features:
  - 'information of feature'

screenshots

screenshots:
  - name: 'name screentshot'
    url: 'url image'
    description: 'decription of screenshots'

introduction

introduction: |-
  example of introduction

usage

usage: |-
  example of usage

Quick Start

quickstart: |-
  example of quick start

requirements

requirements: |-
  This is a list of requirements that need to be installed previously to enjoy all the goodies of this configuration:
  * [gomplate](https://github.com/hairyhenderson/gomplate)

Installation

installation:
  - 'path of file'

examples

examples:
  - 'path of file'

Related Projects

related:
  - name: 'name project related'
    url: 'project related'
    description: 'description of project related'

References

references:
  - name: 'name project references'
    url: 'project references'
    description: 'description of project references'

contributors

# Contributors to this project
contributors:
  - name: 'Luis Mayta'
    github: 'luismayta'

Confluence

Page

confluence:
  space: YAX
  parent: Front
  title: Front-Home

Images

confluence:
  space: YAX
  parent: Front
  title: Front-Home
  images:
    - static/diagrams/architecture.png

GitHub

Repo

# Github Repo to this project
github_repo: devops-toolkit/readme

contributors

# Contributors to this project
contributors:
  - name: 'Luis Mayta'
    github: 'luismayta'

GitLab

Repo

# GitLab Repo to this project
gitlab_repo: devops-toolkit/readme

Custom Repo

# GitLab Repo to this project
gitlab_host: gitlab.domain.com
gitlab_repo: devops-toolkit/readme

Related Projects

Check out these related projects.

• awesome readme - examples of readme

Help

Got a question?

File a GitHub issue.

Contributing

See Contributing.

Module Versioning

This Module follows the principles of Semantic Versioning (SemVer).

Using the given version number of MAJOR.MINOR.PATCH, we apply the following constructs:

1. Use the MAJOR version for incompatible changes.
2. Use the MINOR version when adding functionality in a backwards compatible manner.
3. Use the PATCH version when introducing backwards compatible bug fixes.

Backwards compatibility in 0.0.z and 0.y.z version

• In the context of initial development, backwards compatibility in versions 0.0.z is not guaranteed when z is increased. (Initial development)
• In the context of pre-release, backwards compatibility in versions 0.y.z is not guaranteed when y is increased. (Pre-release)

Copyright

Copyright © 2018-2021 Hadenlabs

Trademarks

All other trademarks referenced herein are the property of their respective owners.

License

The code and styles are licensed under the LGPL-3.0 license See project license..

Don’t forget to 🌟 Star 🌟 the repo if you like readme

Your feedback is appreciated