From 6cd12eb80e950cbbdf94774c95fd196100b4e7e5 Mon Sep 17 00:00:00 2001 From: Eugene Fox Date: Sat, 29 May 2021 03:05:03 +0300 Subject: [PATCH] Updated README and added PR template (#11) --- .github/pull_request_template.md | 11 +++++++++++ README.md | 15 +++++++++++---- 2 files changed, 22 insertions(+), 4 deletions(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..3a87d30 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,11 @@ +Fixes: + +## Changelog +- Item 1 +- Item 2 +- Item 3 + +## PR Checklist +- [ ] Update package version +- [ ] Update CHANGELOG.md +- [ ] Tests and documentation \ No newline at end of file diff --git a/README.md b/README.md index 1c2d09b..16aefb6 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,5 @@ # SimpleOTP -[![GitHub release (latest by date)](https://img.shields.io/github/v/release/xfox111/SimpleOTP)](https://github.com/xfox111/SimpleOTP/releases/latest) - -[![GitHub issues](https://img.shields.io/github/issues/xfox111/SimpleOTP)](https://github.com/xfox111/SimpleOTP/issues) [![GitHub last commit](https://img.shields.io/github/last-commit/xfox111/SimpleOTP)](https://github.com/xfox111/SimpleOTP/commits/master) -[![GitHub repo size](https://img.shields.io/github/repo-size/xfox111/SimpleOTP?label=repo%20size)](https://github.com/xfox111/SimpleOTP) [![MIT License](https://img.shields.io/github/license/xfox111/SimpleOTP)](https://opensource.org/licenses/MIT) [![Twitter Follow](https://img.shields.io/twitter/follow/xfox111?style=social)](https://twitter.com/xfox111) @@ -26,6 +22,7 @@ ##### By Mateusz Adamowski, taken with Canon EOS. - Own work, CC BY-SA 1.0, https://commons.wikimedia.org/w/index.php?curid=142232 ## Usage +See more documentation at [project's wiki](https://github.com/xfox111/SimpleOTP/wiki) ### Generate code ```csharp string sample_config_uri = "otpauth://totp/FoxDev%20Studio:eugene@xfox111.net?secret=ESQVTYRM2CWZC3NX24GRRWIAUUWVHWQH&issuer=FoxDev%20Studio"; @@ -70,10 +67,20 @@ factory.Dispose(); ``` ## Download +![Nuget](https://img.shields.io/nuget/v/SimpleOTP) +![Nuget](https://img.shields.io/nuget/dt/SimpleOTP) - [NuGet Gallery](https://www.nuget.org/packages/SimpleOTP) - [GitHub Releases](https://github.com/xfox111/SimpleOTP/releases/latest) +## CI/DC status +[![Build Status](https://dev.azure.com/xfox111/GitHub%20CI/_apis/build/status/XFox111.SimpleOTP?branchName=master)](https://dev.azure.com/xfox111/GitHub%20CI/_build/latest?definitionId=13) +![Azure DevOps tests](https://img.shields.io/azure-devops/tests/xfox111/GitHub%2520CI/13?label=Tests) +![Azure DevOps coverage](https://img.shields.io/azure-devops/coverage/xfox111/GitHub%2520CI/13?label=Code+coverage) + ## Contributing +[![GitHub issues](https://img.shields.io/github/issues/xfox111/SimpleOTP)](https://github.com/xfox111/SimpleOTP/issues) +[![GitHub repo size](https://img.shields.io/github/repo-size/xfox111/SimpleOTP?label=repo%20size)](https://github.com/xfox111/SimpleOTP) + There are many ways in which you can participate in the project, for example: - [Submit bugs and feature requests](https://github.com/xfox111/SimpleOTP/issues), and help us verify as they are checked in - Review [source code changes](https://github.com/xfox111/SimpleOTP/pulls)