Skip to content

Commit

Permalink
📝 Add initial documentation about repo
Browse files Browse the repository at this point in the history
  • Loading branch information
rmarting committed Jun 15, 2023
1 parent eb0b0eb commit 19ac74d
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# GitHub Repo Template

![License](https://img.shields.io/github/license/rmarting/gh-repo-template?style=plastic)
![Main Lang](https://img.shields.io/github/languages/top/rmarting/gh-repo-template)
![Languages](https://img.shields.io/github/languages/count/rmarting/gh-repo-template)
![Last Commit](https://img.shields.io/github/last-commit/rmarting/gh-repo-template)

This repository includes a set of items to be used as template for any GitHub repository, getting
the most powerful tools and benefits from the GitHub's services.

Some of the items registered here are:

* Badges
* GitHub Workflows

## Badges

Samples including in this readme file:

```markdown
![License](https://img.shields.io/github/license/rmarting/gh-repo-template?style=plastic)
![Main Lang](https://img.shields.io/github/languages/top/rmarting/gh-repo-template)
![Languages](https://img.shields.io/github/languages/count/rmarting/gh-repo-template)
![Last Commit](https://img.shields.io/github/last-commit/rmarting/gh-repo-template)
```

More details [here](https://blog.jromanmartin.io/2023/06/12/Improving-a-gh-repository.html) and in
the services provided by [Shields](https://shields.io/).

## GitHub Workflows

### Release Drafter

Workflows for automatic publishing releases and update changelogs.

More details [here](https://blog.jromanmartin.io/2023/06/12/Improving-a-gh-repository.html).

0 comments on commit 19ac74d

Please sign in to comment.