Skip to content

Commit 039476f

Browse files
committed
Ready for initial release (1.0.1)
1 parent 303e4ef commit 039476f

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ First you need to get this library, either by using [npm (w/ node)](https://node
1111

1212
Then you will need to use it in your application :
1313

14-
* \>= ES6 : `import $json from "jsonclient"`
15-
* Node (<ES6) : `const $json = require("jsonclient")`
16-
* In your HTML files : `<script src="your/path/to/jsonclient.js"></script>`
14+
* \>= ES6 : `import $json from "@voltra/json"`
15+
* Node (<ES6) : `const $json = require("@voltra/json")`
16+
* In your HTML files : `<script src="your/path/to/jsonclient.js"></script>` (exposes the variable `$json`)
1717

1818

1919

@@ -33,7 +33,7 @@ The Promise returned by `$json.get` resolves to the JSON data requested.
3333

3434
### POST requests
3535

36-
If you have made any POST request via the Fetch API, you probably notice that it is very redundant.
36+
If you have made any POST request via the Fetch API, you probably noticed that it is very redundant.
3737

3838
Therefore, this library enables you to ease your job at emitting POST requests.
3939

@@ -45,21 +45,19 @@ Therefore, this library enables you to ease your job at emitting POST requests.
4545

4646
```
4747
$json.post :: (
48-
url: stirng,
48+
url: string,
4949
data: any,
5050
cache: $json.postOptions.Cache,
5151
credentials: $json.postOptions.Credentials,
5252
mode: $json.postOptions.Mode,
5353
redirect: $json.postOptions.Redirect,
54-
referrer: $json.postOptions.Redirect
54+
referrer: $json.postOptions.Referrer
5555
) -> Promise
5656
```
5757

5858

5959

60-
If you have any doubts, you could refer to [Mozilla's guide on how to provide options to `fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#Supplying_request_options)
61-
62-
60+
If you have any doubts, you could refer to [Mozilla's guide on how to provide options to `fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#Supplying_request_options) or ask for advices on my Discord server.
6361

6462
---
6563

0 commit comments

Comments
 (0)