code-readme

README

code-readme

Populate a code readme with actual values.

Description

This project is a github action and a cli tool to populate a code readme with actual values. It uses the github api to get the values.

Table of Contents

Section	Description
Examples
Features	List of all available features
Using the github action	How to use the github action
Using the cli	How to use the cli

Examples

• This repo has {{ index .github.repositories "code-readme" "stars" }} stars.
• This repo has {{ index .github.repositories "code-readme" "forks" }} forks.
• This repo has {{ index .github.repositories "code-readme" "watchers" }} watchers.

See my personal README.md. For more examples see the examples directory.

Features

Feature	Description	Usage	Example
Age	Calculates the age of the developer	{{ .age }}	{{ .age }}
Github Stars	The total amount of stars of all repositories	{{ .github.total_stars }}	{{ .github.total_stars }}
Github Forks	The total amount of forks of all repositories	{{ .github.total_forks }}	{{ .github.total_forks }}
Github Followers	The total amount of followers	{{ .github.followers }}	{{ .github.followers }}
Github Repository Stars	Amount of stars of the given repository	{{ index .github.repositories "[REPOSITORY_NAME]" "stars" }}	{{ index .github.repositories "code-readme" "stars" }}
Github Repository Forks	Amount of forks of the given repository	{{ index .github.repositories "[REPOSITORY_NAME]" "forks" }}	{{ index .github.repositories "code-readme" "forks" }}
Github Repository Watchers	Amount of stars of the given repository	{{ index .github.repositories "[REPOSITORY_NAME]" "forks" }}	{{ index .github.repositories "code-readme" "forks" }}

Replace [VARIABLE] with a valid variable including the squared brackets.

Usage

Using the github action

You can use this project in a github action. The action will generate a readme for your repository.

Using the cli

You can use the cli to generate a readme for your repository.

Configuration

Method A: Use a config file (recommended)

---

Thanks to the following projects

• github-readme-stats - inspiration
• cobra - cli framework
• viper - config management
• pterm - cli output

Documentation

Overview

Copyright © 2023 Nicolas Goldack

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.