From bff8a5c175656d1a6a961c46625903566ca8135d Mon Sep 17 00:00:00 2001 From: Randall Schmidt Date: Fri, 17 Apr 2020 17:09:24 -0400 Subject: [PATCH] update readme --- README.md | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a649c0e..6a154a8 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ node-fetch with caching to a directory on disk. -The first request will result in an HTTP request and any subsequent requests with the same arguments and body function (text, json, buffer, or textConverted) will read the response body from the cache on disk. +The first usage with any given arguments will result in an HTTP request and any subsequent usage with the same arguments and body function (text, json, buffer, or textConverted) will read the response body from the cache on disk. ## Usage -Require it with a path to cache in, and then use it the same way you would use fetch. +Require it with a directory path to cache in, and then use it the same way you would use fetch. ```js const fetch = require('node-fetch-cache')('./path/to/cache/dir'); @@ -18,7 +18,7 @@ fetch('http://google.com') ## API -Note that this is not the full fetch API. Headers and some other things are not accessible. +Note that this does not support the full fetch API. Headers and some other things are not accessible. ### async fetch(resource [, init]) @@ -42,4 +42,4 @@ Returns the body as a Buffer. Identical to CachedResponse.text(), except instead of always converting to UTF-8, encoding sniffing will be performed and text converted to UTF-8, if possible. -(This API requires an optional dependency on [npm package encoding](https://www.npmjs.com/package/encoding), which you need to install manually. \ No newline at end of file +(textConverted requires an optional dependency on [npm package encoding](https://www.npmjs.com/package/encoding), which you need to install manually. \ No newline at end of file diff --git a/package.json b/package.json index 8c36997..d7bfb59 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "node-fetch-cache", - "version": "1.0.2", + "version": "1.0.3", "description": "node-fetch with a persistent cache.", "main": "index.js", "scripts": {