From 19ac74dcaaac8338739fcb4755ea2d525bd7e997 Mon Sep 17 00:00:00 2001 From: Roman Martin Gil Date: Thu, 15 Jun 2023 10:51:57 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20initial=20documentation=20?= =?UTF-8?q?about=20repo?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 8 ++++++++ README.md | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 README.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..15a61af --- /dev/null +++ b/CHANGELOG.md @@ -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] diff --git a/README.md b/README.md new file mode 100644 index 0000000..a32f107 --- /dev/null +++ b/README.md @@ -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).