revamp README in preparation for public release

README.md

@@ -1,6 +1,6 @@
 # Obsidian LLM docs
 
-This is a plugin for Obsidian (https://obsidian.md) that lets you chat with LLMs in plain markdown files!
+A plugin for Obsidian (https://obsidian.md) that lets you chat with LLMs in plain markdown files!
 
 ## Features
 
@@ -8,30 +8,26 @@ This is a plugin for Obsidian (https://obsidian.md) that lets you chat with LLMs
 - Integrates with the OpenAI API
 - Also works with self-hosted/local LLMs that expose an OpenAI-compatible API, like Ollama (https://ollama.com)
 - Can follow links to other Obsidian documents included in your prompt, making it easier to include additional context
+- Supports linked/embedded images in prompt
 
-## Dev installation
+## How to use
 
-- Install/use the version of NodeJS specified in the `.tool-versions` file
-- Run `npm i` to install dependencies.
-- Run `npm run dev` to start compilation in watch mode.
-- Reload Obsidian.
-- Enable plugin in settings window.
-- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
+### 1. Update your configuration
 
-## Releasing new releases
+Open the Obsidian settings window and select "LLM docs" under "Community plugins":
 
-- 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.
+![settings.png](docs/settings.png)
 
-> 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`
+### 2. Create an LLM document
 
-## Adding your plugin to the community plugin list
+Create a new document by clicking the LLM docs icon (looks like a robot) in the sidebar, or running the "Create new LLM document" command (use it from the command palette, or assign a keyboard shortcut)
 
-- Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines).
-- 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.
+### 3. Prompt the LLM
+
+Type in your prompt and click "Complete" to generate a response! (or bind a keyboard shortcut)
+
+![completion-example.gif](docs/completion-example.gif)
+
+## If you like it, I'm grateful for your support!
+
+<a href='https://ko-fi.com/V7V019UAWY' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi6.png?v=6' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>

docs/dev.md

@@ -0,0 +1,26 @@
+## Dev installation
+
+- Install/use the version of NodeJS specified in the `.tool-versions` file
+- Run `npm i` to install dependencies.
+- Run `npm run dev` to start compilation in watch mode.
+- Reload Obsidian.
+- 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 the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines).
+- 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.

manifest.json

@@ -3,7 +3,7 @@
 	"name": "LLM docs",
 	"version": "1.0.0",
 	"minAppVersion": "1.7.0",
-	"description": "Chat with LLM (ChatGPT) inside Obsidian files",
+	"description": "Simple LLM (AI) client using pure markdown documents",
 	"author": "Shane Lamb",
 	"authorUrl": "https://lambo.land",
 	"fundingUrl": "https://ko-fi.com/shanelamb",

styles.css

@@ -66,3 +66,11 @@ If your plugin does not need CSS, delete this file.
 .llmdocs-suggest-item-subtext {
 	color: var(--text-muted);
 }
+
+.llmdocs-suggest-item-title {
+	font-weight: 600;
+}
+
+.llmdocs-suggest-item-subtext {
+	color: var(--text-muted);
+}