jimp-dev/jimp

Documentation lacks info about EXIF handling

Open

#991 opened on Mar 3, 2021

View on GitHub
 (0 comments) (2 reactions) (0 assignees)JavaScript (13,218 stars) (785 forks)batch import
documentationhelp wanted

Description

Expected Behavior

Documentation includes EXIF handling:

  • how can EXIF be accessed
  • how to PRESERVE or copy EXIF to.clone() instance
  • how to add new EXIF data, if no EXIF was set / is in the image
  • how to manipulate existing EXIF data
  • how to EXIF-Auto-Rotate (I believe I read somewhere about this)
  • is anyhing besides EXIF supported?

Current Behavior

Documentatin is missing info about EXIF.

Failure Information (for bugs)

none.

Steps to Reproduce

Read the readme.md

Context

  • Jimp Version: 0.16.1
  • Operating System: OSX /Win latest
  • Node version: 15.11.0

Failure Logs

none.

Contributor guide

Tech stack
javascriptnodejs
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of EXIF metadatafamiliarity with Jimp API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Review the current README.md file at https://github.com/jimp dev/jimp/blob/master/README.md. The issue requests adding documentation for accessing EXIF data, preserving it when cloning images, adding new EXIF data, manipulating existing EXIF, auto rotation, and whether other metadata formats are supported. Look for existing Jimp methods like `exif` or `exifRotate` in the source code (possibly in src/image/exif.js). The documentation should explain how to use these methods with examples. Since the issue is from 2021 and Jimp may have evolved, check the latest version's API to ensure accuracy.