diff --git a/README.md b/README.md index 7b9c43a..b1f5237 100644 --- a/README.md +++ b/README.md @@ -5,31 +5,47 @@ # Obsidian Image to Text -Recognize Text on images in your notes. Replace the image with the text or append it to the image. +Recognize Text on images in your notes. Select the image and run the command. The recognized text will be appended to your image or will replace your image - depending on the command ## Commands -| Command | Description | -| -------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| Image To Text: Replace Selection | Replace your image with the recognized text. Recognize text based on language defined in settings | -| Image To Text: Replace Selection - custom language | Replace your image with the recognized text. Recognize text based on custom selection | -| Image To Text: Append Selection | Append the recognized text to your image. Recognize text based on language defined in settings | -| Image To Text: Append Selection - custom language | Append the recognized text to your image. Recognize text based on custom selection | +| Command | Description | +| -------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| Image To Text: Replace Selection | Replace your image with the recognized text. Recognize text based on the language defined in settings | +| Image To Text: Replace Selection - custom language | Replace your image with the recognized text. Recognize text based on custom selection | +| Image To Text: Append Selection | Append the recognized text to your image. Recognize text based on language defined in settings | +| Image To Text: Append Selection - custom language | Append the recognized text to your image. Recognize text based on custom selection | -### Example +## Example -Example Image: -![Lorem ipsum Image](./demo/loremipsum.png) - -Show Case: ![Lorem ipsum Animated](./demo/loremipsum.gif) +## Supported Image Types + +- .jpg +- .jpeg +- .png +- .gif +- .bmp +- .pbm +- .webp + +## Supported Markup + +| Format | Example | Description | +| ----------------------------- | --------------------------------------------------- | ---------------------------------- | +| Obsidian Image | `![[example.png]]` | Obsidian image tag | +| Obsidian Image including size | `![[example.png\|300]]` | Obsidian image tag including size | +| Markdown Image | `![Image](https://www.example.com/example.png)` | Markdown image tag | +| URL | `https://www.example.com/example.png` | URL to an image | +| img Tag | `` | Img tag with a valid src attribute | + ## Installation ### Community Plugin - Follow this link [Obsidian Plugin](https://obsidian.md/plugins?id=image-to-text-ocr) -- Or open Obsidian Settings, go to Community Plugins, browse "Image to Text OCR" click install and activte. +- Or open Obsidian Settings, go to Community Plugins, browse "Image to Text OCR" click install and activate. ### Manually installing the plugin @@ -37,12 +53,22 @@ Show Case: - Download `main.js`, `manifest.json` - save into your vault `VaultFolder/.obsidian/plugins/obsidian-image-to-text-ocr/` -## Roadmap +### Settings + +| Name | Description | +| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| Content language | Select language to recognize. Default is Englisch. If images contain special characters, changing the language may perform better results | +| Enable debug logging | If enabled, more will be logged in the console. | -- Enable recognition on images with defined size +## Ressources + +This plugin uses [tesseract.js](https://github.com/naptha/tesseract.js/) to recognize text. ## Contribution - Feel free to [open an issue](https://github.com/dario-baumberger/obsidian-image-to-text-ocr/issues) if you miss something - Feel free to open a Pull request to implement a feature - - Please extend tests if you ad logic + - Please extend tests if you add logic + +todo +command icons