diff --git a/README.md b/README.md index 040456c..2d4cf7b 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,8 @@ The `options` object supports the following options: If `callback` is not provided, the method returns a `Promise`. +## Example + ```js const { info } = require('fastimage') @@ -64,7 +66,7 @@ The callback argument (or the resolved value) will be an object with the followi } ``` -### Stream +## Streams Calling `fastimage.stream` it will return a Writable stream which will emit the `info` event once informations are ready. diff --git a/package.json b/package.json index 28da6c9..2e70c76 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "version": "3.0.0", "description": "A module that finds the size and type of an image by fetching and reading as little data as needed.", "homepage": "https://sw.cowtech.it/fastimage", - "repository": "github:/ShogunPanda/fastimage", + "repository": "github:ShogunPanda/fastimage", "keywords": [ "fast", "fastimage", @@ -53,7 +53,7 @@ "image-size": "^0.9.3" }, "devDependencies": { - "@cowtech/eslint-config": "^7.12.2", + "@cowtech/eslint-config": "^7.14.0", "@types/node": "^14.14.19", "@types/tap": "^14.10.1", "prettier": "^2.2.1",