Skip to content

Add a README to the image package #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CameeronS merged 1 commit into from
Feb 10, 2025
Merged

Add a README to the image package #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions packages/image/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:


` <Image src={(minimaToken.url} /> `

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.

2 changes: 1 addition & 1 deletion packages/image/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand Down