search

hMatoba / piexifjs

Read and modify exif in client-side or server-side JavaScript.
MIT License
572 stars 119 forks source link

Improve documentation #41

Open HarelM opened 6 years ago

HarelM commented 6 years ago

Hi, First and foremost, thanks for this great library! While I think the code is generally written well, I saw that in order to use this library I need to read it after reading the documentation as I didn't find what I was looking for in the documentation. Furthermore, intellisense is not available and this too would be extremely helpful. DefinitelyTyped is a project that is used to create intellisense to javascript libraries for TypeScript, which is currently used by Google and Microsoft.

A use case for example: Get GPS coordinates from exif data. The currently documentation only specify a method in the helper to write GPS coordinates, however, the code has the opposite method as well, but it can't be found in the docs and only looking at the code can reveal it.

TomasHubelbauer commented 5 years ago

Hey, the docs are hosted by ReadTheDocs which should be editable on GitHub. Would be cool for you to create a PR with the changes you would like to see, I am also looking for more examples, so any real world use cases you have figured out would be a great contribution to the docs for others to study.