Merge pull request #5 from DSI-HUG/develop

doc(README)

README.md

@@ -2,13 +2,13 @@
 
 [![npm version](https://img.shields.io/npm/v/@hug/ngx-sentry.svg?logo=npm&logoColor=fff&label=NPM+package&color=limegreen)](https://www.npmjs.com/package/@hug/ngx-sentry) [![npm downloads](https://img.shields.io/npm/dm/@hug/ngx-sentry.svg?style=flat-square)](https://npmcharts.com/compare/@hug/ngx-sentry?minimal=true) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) [![Build Status](https://github.com/GITHUG_REPO_NAME/workflows/CI/badge.svg)](https://github.com/GITHUG_REPO_NAME/actions?query=workflow:CI) [![Dependency Status](https://img.shields.io/david/GITHUG_REPO_NAME.svg?style=flat-square)](https://david-dm.org/GITHUG_REPO_NAME) [![devDependency Status](https://img.shields.io/david/dev/GITHUG_REPO_NAME.svg?style=flat-square)](https://david-dm.org/GITHUG_REPO_NAME#info=devDependencies)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) [![Build Status](https://github.com/DSI-HUG/ngx-sentry/workflows/CI/badge.svg)](https://github.com/DSI-HUG/ngx-sentry/actions?query=workflow:CI) [![Dependency Status](https://img.shields.io/david/DSI-HUG/ngx-sentry.svg?style=flat-square)](https://david-dm.org/DSI-HUG/ngx-sentry) [![devDependency Status](https://img.shields.io/david/dev/DSI-HUG/ngx-sentry.svg?style=flat-square)](https://david-dm.org/DSI-HUG/ngx-sentry#info=devDependencies)
 
 <!-- edit: description -->
 
 ## Installation
 
-To set up an Angular project with this library, use the Angular CLI's installation [schematic][schematics]:
+To set up an Angular project with this library use the Angular CLI's installation [schematic][schematics]:
 
 ```sh
 ng add @hug/ngx-sentry
@@ -65,12 +65,12 @@ The library and schematics can be tested on an Angular project while being devel
    ng add @hug/ngx-sentry
    ```
 
-**Tips:** ***you can use git to watch the effective changes made by the schematics***
+**Tips** - ***you can use git to watch the effective changes made by the schematics:***
 
 1. Make a clean state after creating the dummy Angular project
 
    ```sh
-   git commit -am 'first commit'
+   git commit -am 'clean state'
    ```
 
 2. Run the schematics and check the changes
@@ -97,6 +97,7 @@ npm run test:schematics
 ### Building the library
 
 The library will be built in the `./dist/library` directory.
+
 Schematics will be embedded within the library under `./dist/library/schematics`.
 
 ```sh
@@ -111,21 +112,23 @@ This project comes with automatic continuous delivery (CD) using GitHub Actions.
 
 2. Push the changes
 
-3. Create a new [GitHub release](https://github.com/@hug/ngx-sentry/releases/new)
+3. Create a new: [GitHub release](https://github.com/@hug/ngx-sentry/releases/new)
 
-4. Watch the results in : [Actions](https://github.com/@hug/ngx-sentry/actions)
+4. Watch the results in: [Actions](https://github.com/@hug/ngx-sentry/actions)
 
 
 ## Contributing
 
 ### Want to Help?
 
 Want to file a bug, contribute some code or improve documentation? Excellent!
+
 But please read up first on the guidelines for [contributing][contributing], and learn about submission process, coding rules and more.
 
 ### Code of Conduct
 
 Help us keep this project open and inclusive.
+
 Please read and follow the [Code of Conduct][codeofconduct].