diff --git a/packages/image/README.md b/packages/image/README.md new file mode 100644 index 0000000..792c1c5 --- /dev/null +++ b/packages/image/README.md @@ -0,0 +1,13 @@ +# Minima Image Handbook + +This package is made to facilitate image composability across the Minima dApp eco-system. + +It has both a re-usable React component labelled `Image` and utility methods that can be used independently especially useful for processing, compressing, and fetching images from various sources, including base64 encodings and IPFS/IPNS. + +The `Image` tag that can be imported by `import { Image } from "@minima-global/image"` and then using it like: + + +` ` + +Otherwise you can have a look at how the Image component was built using the utility functions in the `/utils` folder part of the package. + diff --git a/packages/image/package.json b/packages/image/package.json index fd53bc4..878d2d5 100644 --- a/packages/image/package.json +++ b/packages/image/package.json @@ -1,6 +1,6 @@ { "name": "@minima-global/image", - "version": "1.5.3", + "version": "1.5.4", "type": "module", "main": "dist/index.js", "module": "dist/index.esm.js",