From c4d991b13cbb2e7bea2a7dab670c6ee36804bb3f Mon Sep 17 00:00:00 2001 From: Adam McKellar Date: Tue, 23 Apr 2024 17:28:17 +0200 Subject: [PATCH] Added codecov badge. Made readme nicer. Added changelog. --- CHANGELOG.md | 14 ++++++++++++++ README.md | 10 ++++++++-- TODO.md | 22 ---------------------- 3 files changed, 22 insertions(+), 24 deletions(-) create mode 100644 CHANGELOG.md delete mode 100644 TODO.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..5a27da9 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,14 @@ +# 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] + +### Added + +* Generated project with template. +* Added badges. +* Added contributors. diff --git a/README.md b/README.md index c9fb67b..44a3eeb 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,14 @@ -# Welcome to installation-instruction +
+ +# `installation-instruction` + +**Library for checking and parsing installation instruction schemas.** ![GitHub License](https://img.shields.io/github/license/instructions-d-installation/installation-instruction) [![Documentation Status](https://readthedocs.org/projects/installation-instruction/badge/?version=latest)](https://installation-instruction.readthedocs.io/en/latest/?badge=latest) -[![codecov](https://codecov.io/none/None/None/branch/main/graph/badge.svg)](https://codecov.io/none/None/None) +[![codecov](https://codecov.io/gh/instructions-d-installation/installation-instruction/graph/badge.svg?token=5AIH36HYG3)](https://codecov.io/gh/instructions-d-installation/installation-instruction) + +
## Installation diff --git a/TODO.md b/TODO.md deleted file mode 100644 index 0c8e53e..0000000 --- a/TODO.md +++ /dev/null @@ -1,22 +0,0 @@ -This TODO list is automatically generated from the cookiecutter-python-project template. -The following tasks need to be done to get a fully working project: - -* Set up a remote repository. You can e.g. create a project in GitHub or GitLab and run - the following commands in your locally generated project folder: `git remote add origin ` - For a seamless integration, the name of the project should also be `installation-instruction`. -* Head to your user settings at `https://pypi.org` and setup PyPI trusted publishing. - In order to do so, you have to head to the "Publishing" tab, scroll to the bottom - and add a "new pending publisher". The relevant information is: - * PyPI project name: `installation_instruction` - * Owner: `None` - * Repository name: `installation-instruction` - * Workflow name: `pypi.yml` - * Environment name: not required -* Enable the integration of Readthedocs with your Git hoster. In the case of Github, this means - that you need to login at [Read the Docs](https://readthedocs.org) and click the button - *Import a Project*. -* Enable the integration with `codecov.io` by heading to the [Codecov.io Website](https://codecov.io), - log in (e.g. with your Github credentials) and enable integration for your repository. In order to do - so, you need to select it from the list of repositories (potentially re-syncing with GitHub) and head - to the Settings Tab. Within setting, get your token for this repository and put store it as a secret - called `CODECOV_TOKEN` for GitHub Actions.