Skip to content

Commit 0774bc9

Browse files
committed
docs: Update README
1 parent f8cd795 commit 0774bc9

File tree

2 files changed

+26
-2
lines changed

2 files changed

+26
-2
lines changed

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,22 @@ Provides a functor for creating and providing your own Fetch-implementation. The
2121

2222
A consumable fetch-library for ReasonML/OCaml native. Uses `Lwt` for its `Promise`-implementation.
2323

24+
To install, add the library to your esy-manifest, like so:
25+
26+
```json
27+
{
28+
"dependencies": {
29+
"fetch-native-lwt": "lessp/fetch:fetch-native-lwt.json"
30+
}
31+
}
32+
```
33+
34+
or, to point to a specific commit:
35+
36+
```json
37+
"fetch-native-lwt": "lessp/fetch:fetch-native-lwt.json#<commit-hash>"
38+
```
39+
2440
## Contributing
2541

2642
Feel free to open an issue and/or grabbing one of the [open issues](https://github.com/lessp/reason-fetch/issues).

src/fetch-native-lwt/README.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,19 @@ Fetch client for native ReasonML.
99
Currently to install, you'll need `esy` and pin `fetch-native-lwt` to point to this Github-repo.
1010

1111
```json
12-
"dependencies": {
13-
"fetch-native-lwt": "lessp/fetch:fetch-native-lwt.json#<commit-hash>"
12+
{
13+
"dependencies": {
14+
"fetch-native-lwt": "lessp/fetch:fetch-native-lwt.json"
15+
}
1416
}
1517
```
1618

19+
or, to point to a specific commit:
20+
21+
```json
22+
"fetch-native-lwt": "lessp/fetch:fetch-native-lwt.json#<commit-hash>"
23+
```
24+
1725
2. Add Fetch to your dune libraries:
1826

1927
```lisp

0 commit comments

Comments
 (0)