From f0fe2f8decb4aeced3b34043f91a6c9066a5e954 Mon Sep 17 00:00:00 2001 From: Jason Staten Date: Mon, 9 Dec 2019 09:40:47 -0700 Subject: [PATCH] fix(docs): Add issue tracker Add issue tracker badge into README and `bugs` key into package.json --- README.md | 23 +++++++++++++---------- package.json | 4 ++++ 2 files changed, 17 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 760bf8f..66a1bbe 100644 --- a/README.md +++ b/README.md @@ -8,21 +8,22 @@ AngularJS Testing Library is a lightweight adapter built on top of [![version][version-badge]][package] [![downloads][downloads-badge]][npmtrends] -[![MIT License][license-badge]][license] +[![MIT License][license-badge]][license] [![issues todo.sr.ht][issues-badge]][issues] ## Table of Contents + -- [The problem](#the-problem) -- [This solution](#this-solution) -- [Installation](#installation) -- [Examples](#examples) - - [Basic Example](#basic-example) -- [Guiding Principles](#guiding-principles) -- [LICENSE](#license) +* [The problem](#the-problem) +* [This solution](#this-solution) +* [Installation](#installation) +* [Examples](#examples) + * [Basic Example](#basic-example) +* [Guiding Principles](#guiding-principles) +* [LICENSE](#license) @@ -155,7 +156,7 @@ light-weight, simple, and understandable. ## LICENSE -[MIT](LICENSE) +[MIT][license] @@ -166,7 +167,9 @@ light-weight, simple, and understandable. [downloads-badge]: https://img.shields.io/npm/dm/angularjs-testing-library.svg?style=flat-square [npmtrends]: http://www.npmtrends.com/angularjs-testing-library [license-badge]: https://img.shields.io/npm/l/angular-testing-library.svg?style=flat-square -[license]: https://example.com +[license]: https://opensource.org/licenses/MIT +[issues-badge]: https://img.shields.io/badge/issues-todo.sr.ht-orange?style=flat-square +[issues]: https://todo.sr.ht/~statianzo/angularjs-testing-library [guiding-principle]: https://twitter.com/kentcdodds/status/977018512689455106 diff --git a/package.json b/package.json index df84583..6ec79cc 100644 --- a/package.json +++ b/package.json @@ -100,6 +100,10 @@ "url": "https://git.sr.ht/~statianzo/angularjs-testing-library" }, "homepage": "https://git.sr.ht/~statianzo/angularjs-testing-library", + "bugs": { + "url": "https://todo.sr.ht/~statianzo/angularjs-testing-library", + "email": "~statianzo/angularjs-testing-library@todo.sr.ht" + }, "release": { "plugins": [ "@semantic-release/commit-analyzer",