Merge pull request #28 from MohrJonas/develop

Merge develop into master

.gitignore

@@ -20,3 +20,4 @@ data.json
 
 # Exclude macOS Finder (System Explorer) View States
 .DS_Store
+/out/

README.md

@@ -71,10 +71,21 @@ For the path: check where the binaries are located and add these to "/private/et
 
 ##### Arch / Manjaro
 
+###### Manual installation
+
 - Run `sudo pacman -S tesseract imagemagick`
 - Install any languages you need by installing the appropriate package (usually named `tesseract-data-<lang>`)
 
-Note - if Obsidian is running via the Flatpak installation (such as provided by default in Pop!_OS) then this plugin
+###### Automatic installation
+
+❗The automatic installation features is still in very early development. Expect bugs❗
+
+- Install & enable the plugin
+- Under `settings`, press the `automatic install` button
+
+#### Flatpak
+
+If Obsidian is running via the Flatpak installation (such as provided by default in Pop!_OS) then this plugin
 will not operate. Flatpak sandboxing will change the filepaths so even providing host access will still be problematic.
 If you have a Flatpak installation you will need to reinstall via a different method to successfully use this plugin.
 
@@ -130,7 +141,13 @@ By default, tesseract offers two languages to choose from: `eng` and `osd`.
 ℹ After switching your language, only newly indexed documents use the new language. You can reindex your already added
 documents by using the `Delete all transcripts` command ℹ
 
+###### Lang vs Script
+
+Tesseract supports `langs` and `scripts` for text recognition.
+- Langs support a single language
+- Scripts support multiple languages with similar characters. Latin, for example, supports all latin-based languages (English, German, Italian, France, ...) except for Vietnamese
+
 #### Custom OCR providers
 
 To add a custom OCR provider, create a new class that extends `OCRProvider` and register it
-using `OCRProviderManager.registerOCRProviders(new MyCustomProvider())`
+using `OCRProviderManager.registerOCRProviders(new MyCustomProvider())`

esbuild.config.mjs

@@ -58,6 +58,11 @@ esbuild.build({
 	logLevel: "info",
 	sourcemap: prod ? false : "inline",
 	treeShaking: true,
+    minify: false,
+    minifyIdentifiers: false,
+    minifySyntax: false,
+    minifyWhitespace: false,
+    keepNames: true,
 	outfile: "main.js",
 	plugins: [inlineWorkerPlugin()]
 }).catch(() => process.exit(1));

manifest.json

@@ -6,5 +6,6 @@
   "description": "Add ocr capabilities to obsidian",
   "author": "Jonas Mohr",
   "authorUrl": "https://github.com/MohrJonas/obsidian-ocr",
+  "fundingUrl": "https://ko-fi.com/mohrjonas",
   "isDesktopOnly": true
 }