Skip to content

Commit 5dbf571

Browse files
committed
docs: updating readme to follow project template
1 parent 9d7553c commit 5dbf571

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
1-
# http-client
1+
# @podium/http-client
22

33
⚠️ This project is still work in progress, should not be used for anything just yet.
44

55
Generic http client built on [undici](undici.nodejs.org/) with a circuit breaker, error handling and metrics out of the box.
6+
7+
[![Dependencies](https://img.shields.io/david/podium-lib/http-client.svg)](https://david-dm.org/podium-lib/http-client)
8+
[![GitHub Actions status](https://github.com/podium-lib/http-client/workflows/Run%20Lint%20and%20Tests/badge.svg)](https://github.com/podium-lib/layout/actions?query=workflow%3A%22Run+Lint+and+Tests%22)
9+
[![Known Vulnerabilities](https://snyk.io/test/github/podium-lib/http-client/badge.svg)](https://snyk.io/test/github/podium-lib/http-client)
10+
11+
## Installation
12+
13+
```bash
14+
$ npm install @podium/http-client
15+
```
16+
17+
## Usage
18+
19+
20+
```js
21+
22+
```
23+
24+
## Constructor

0 commit comments

Comments
 (0)