Skip to content

Commit 61319b8

Browse files
authored
Update README.md
1 parent 3b0c899 commit 61319b8

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,25 @@
1717
</p>
1818

1919
## Installation
20+
---------
2021

2122
```sh
2223
npm i --save kb-burly
2324
```
2425

25-
## Usage
26+
Usage
27+
---------
28+
29+
2630
[![Edit burly-examples-t6lzw](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/burly-examples-t6lzw)
27-
#### Basic Example:
31+
#### Basic:
2832

2933
```ts
3034
const burly = Burly("https://api.com/find")
3135
.addParam("id", 1234)
3236
.get; // = https://api.com/find?id=1234
3337
```
34-
#### Nested Example:
38+
#### Nested query:
3539

3640
```ts
3741
const object = {
@@ -44,13 +48,19 @@ const burly = Burly('http://test.com')
4448
.addQuery('where', object)
4549
.get; // = http://test.com?where=yes%3D%27no%27%26maybe%3D%27%2Ftest%2F%27
4650
```
47-
#### Bad Parameter Example:
51+
#### Null parameter:
4852
```ts
4953
const burly = Burly("http://bad-param.blog")
5054
.addParam('bad', null)
5155
.get; // = http://bad-param.blog
5256
```
5357

54-
## Credits
58+
Reference:
59+
----------
60+
61+
###### new Burly([baseURL])
62+
63+
Credits
64+
--------
5565

5666
_Based heavily on [url-assembler](https://github.com/Floby/node-url-assembler) by Florent Jaby_

0 commit comments

Comments
 (0)