add short readme

This commit is contained in:
jkhsjdhjs 2019-01-14 04:46:38 +01:00 committed by GitHub
parent bcca25ff07
commit 901198d8cb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

13
README.md Normal file
View File

@ -0,0 +1,13 @@
# node-fetch-cookies
node-fetch wrapper that adds support for cookie-jars
## Example Usage
```javascript
import cookies from "node-fetch-cookies";
// "rw" are the flags, meaning cookies will be read and written from/to the cookie jar. r = read, w = write
// second argument is the filename, can also be undefined if you don't want to read/write the cookies from/to a file
let cookieJar = new cookies.CookieJar("rw", "path/to/file.json");
// first parameter is the url, second the options, just like node-fetch. third parameter is the cookie jar
// returns a response object just like node-fetch
cookies.fetch("https://example.page/example/path", null, cookieJar);
```