GOMODULES
/
go-exif
mirror of https://github.com/dsoprea/go-exif.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

README.md: Move v2 notes to bottom. Add notes about IFD and tag customization.

dustin/master
Dustin Oprea 2020-05-20 01:00:53 -04:00
parent 1b9bb61b5f
commit 04a4b5ce62
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -7,11 +7,6 @@
This package provides native Go functionality to parse an existing EXIF block, update an existing EXIF block, or add a new EXIF block.
# *NOTICE*
**This project is modulized and v2 is now available (in v2/). This features a heavily reflowed interface that makes usage much simpler.** The undefined-type tag-processing (which affects most photographic images) has also been overhauled and streamlined. It is now complete and stable. Adoption is strongly encouraged.
# Getting
To get the project and dependencies:
@ -41,6 +36,13 @@ The library often refers to an IFD with an "IFD path" (e.g. IFD/Exif, IFD/GPSInf
There is an "IFD mapping" and a "tag index" that must be created and passed to the library from the top. These contain all of the knowledge of the IFD hierarchies and their tag-IDs (the IFD mapping) and the tags that they are allowed to host (the tag index). There are convenience functions to load them with the standard TIFF information, but you, alternatively, may choose something totally different (to support parsing any kind of EXIF data that does not follow or is not relevant to TIFF at all).
# Standards and Customization
This project is configuration driven. By default, it has no knowledge of tags and IDs until you load them prior to using (which is incorporated in the examples). You are just as easily able to add additional custom IFDs and custom tags for them. If desired, you could completely ignore the standard information and load *totally* non-standard IFDs and tags.
This would be useful for divergent implementations that add non-standard information to images. It would also be useful if there is some need to just store a flat list of tags in an image for simplified, proprietary usage.
# Reader Tool
There is a runnable reading/dumping tool included:
@ -100,6 +102,13 @@ $ go test github.com/dsoprea/go-exif/v2/...
```
# Release Notes
## v2 Release
**This project is modulized and v2 is now available (in v2/). This features a heavily reflowed interface that makes usage much simpler.** The undefined-type tag-processing (which affects most photographic images) has also been overhauled and streamlined. It is now complete and stable. Adoption is strongly encouraged.
# *Contributing*
EXIF has an excellently-documented structure but there are a lot of devices and manufacturers out there. There are only so many files that we can personally find to test against, and most of these are images that have been generated only in the past few years. JPEG, being the largest implementor of EXIF, has been around for even longer (but not much). Therefore, there is a lot of compatibility to test for.