diff --git a/README.md b/README.md index 6bc1955..cae81be 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,49 @@ -# WIP - - -Ensure you have the latest version of ollama installed; - ---- ---- ---- - -# Obsidian Sample Plugin - -This is a sample plugin for Obsidian (https://obsidian.md). - -This project uses Typescript to provide type checking and documentation. -The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does. - -**Note:** The Obsidian API is still in early alpha and is subject to change at any time! - -This sample plugin demonstrates some of the basic functionality the plugin API can do. -- Adds a ribbon icon, which shows a Notice when clicked. -- Adds a command "Open Sample Modal" which opens a Modal. -- Adds a plugin setting tab to the settings page. -- Registers a global click event and output 'click' to the console. -- Registers a global interval which logs 'setInterval' to the console. - -## First time developing plugins? - -Quick starting guide for new plugin devs: - -- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with. -- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it). -- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder. -- Install NodeJS, then run `npm i` in the command line under your repo folder. -- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`. -- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`. -- Reload Obsidian to load the new version of your plugin. -- Enable plugin in settings window. -- For updates to the Obsidian API run `npm update` in the command line under your repo folder. - -## Releasing new releases - -- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release. -- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible. -- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases -- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release. -- Publish the release. - -> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`. -> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json` - -## Adding your plugin to the community plugin list - -- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md -- Publish an initial version. -- Make sure you have a `README.md` file in the root of your repo. -- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin. +# Obsidian AI Image Analyser Plugin + +This plugin allows you to analyze images in Obsidian using the Ollama API. +Because of this it requires Ollama to be installed and running on some machine. +Ensure you have the newest version of Ollama installed. + +## Features +It analyses images and returns a keyword list of the image. + +Currently it supports: +- `jpg` +- `jpeg` +- `png` +- `webp` + +### OmniSearch +The plugin was made to integrate with the Obsidian [OmniSearch](https://github.com/scambier/obsidian-omnisearch) Plugin. +As soon as this plugin is available in the community plugins, I will create a PR to add the integration. + +### Cache & Sync +The plugin caches the results of the analysis, so it doesn't have to be done every time. +It caches the result in a json file inside the plugin folder. +Those files can be synced between devices. + +## Installation +You can download the latest release from the GitHub [releases page](https://github.com/swaggeroo/obsidian-ai-image-analyser/releases) and install it manually in Obsidian. +In the future, this plugin will hopefully be available in the Obsidian community plugins. + +## Using AI image analyser as a dependency for your plugin +The exposed API: +```typescript +// Add this type somewhere in your code +export type AIImageAnalyzerAPI = { + analyzeImage: (file: TFile) => Promise; + canBeAnalyzed: (file: TFile) => boolean; + isInCache: (file: TFile) => boolean; +} + +// Then, you can just use this function to get the API +export function getAIImageAnalyser(): AIImageAnalyzerAPI | undefined { + return (app as any).plugins?.plugins?.['obsidian-ai-image-analyzer']?.api +} + +// And use it like this +const text = await getAIImageAnalyser()?.analyzeImage(file) +``` + +## Contributing +If you want to contribute to this plugin, you can do so by creating a pull request or an issue on the GitHub repository.