firebase-extensions icon indicating copy to clipboard operation
firebase-extensions copied to clipboard

[image-processing-api] Improve documentation

Open Salakar opened this issue 4 years ago • 2 comments

Documentation should be updated and improved;

  • 'Text' operation has incorrect description and is missing the 'value' property; https://github.com/invertase/firebase-extensions/blob/main/extensions/image-processing-api/functions/src/operations/text.ts#L36
  • Preview/example images not working (the deployed instance of the extension for demo purposes seemed to have been uninstalled.

Salakar avatar Jul 14 '21 10:07 Salakar

I need more information about the text capabilities. In particular handling fonts. How do I get this? The documentation is non-existent at the moment.

leeprobert avatar Apr 12 '23 11:04 leeprobert

I need more information about the text capabilities. In particular handling fonts. How do I get this? The documentation is non-existent at the moment.

@leeprobert we do have docs; https://extensions.invertase.dev/image-processing-api/operations#text - however they seem to need a bunch of fixes and updates.

In terms of the 'text' operation, the code docs are up to date here: https://github.com/invertase/firebase-extensions/blob/main/extensions/image-processing-api/functions/src/operations/text.ts#L36 - you can specify a 'value' as well as the various styling properties, internally this will draw the text as an SVG and composite on top of your existing image

Salakar avatar Apr 25 '23 16:04 Salakar