pre-publishing details

This commit is contained in:
djayatillake 2025-01-23 22:57:12 +00:00
parent ac07b8c97b
commit 484cfa44f8
3 changed files with 94 additions and 4 deletions

21
LICENSE Normal file
View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2025 David Jayatillake
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

67
README.md Normal file
View file

@ -0,0 +1,67 @@
# Obsidian LLM Tagger Plugin
This plugin uses Ollama to automatically tag your Obsidian notes using large language models running locally on your machine.
## Features
- 🤖 Uses local LLMs via Ollama for privacy and speed
- 🏷️ Automatically generates relevant tags for your notes
- 📝 Creates brief summaries with tags while preserving original content
- ⚡ Auto-tagging option for new and modified files
- 🎯 Customizable tag list for focused tagging
- 🔄 Smart processing that avoids re-tagging unchanged files
## Prerequisites
1. [Obsidian](https://obsidian.md/) v1.0.0 or higher
2. [Ollama](https://ollama.ai/) installed and running locally
## Installation
### From Obsidian Community Plugins
1. Open Obsidian Settings
2. Go to Community Plugins
3. Search for "LLM Tagger"
4. Click Install, then Enable
### Manual Installation
1. Download the latest release
2. Extract files to your vault's `.obsidian/plugins/obsidian-llm-tagger/` directory
3. Reload Obsidian
4. Enable the plugin in Community Plugins settings
## Usage
1. Click the robot icon in the left sidebar to open the tagger panel
2. Select your preferred Ollama model (e.g., llama2, mistral)
3. Enter your desired tags, separated by commas
4. Click "Start Tagging" to process your notes
### Auto-tagging
Enable auto-tagging in the plugin settings to automatically tag new or modified notes.
## Configuration
- **Model Selection**: Choose any Ollama model you have installed
- **Default Tags**: Set your commonly used tags
- **Auto-tagging**: Toggle automatic tagging of new/modified files
## Development
```bash
# Clone the repository
git clone https://github.com/yourusername/obsidian-llm-tagger.git
# Install dependencies
npm install
# Build
npm run build
```
## License
MIT License - see [LICENSE](LICENSE) for details

View file

@ -2,11 +2,13 @@
"id": "obsidian-llm-tagger",
"name": "LLM Tagger",
"version": "1.0.0",
"minAppVersion": "0.9.7",
"description": "A plugin that uses LLMs with Ollama to add tags from a user-defined list to all documents in a vault.",
"minAppVersion": "1.0.0",
"description": "Automatically tag your notes using local LLMs via Ollama",
"author": "David Jayatillake",
"authorUrl": "https://github.com/david-jayatillake",
"authorUrl": "https://github.com/djayatillake",
"isDesktopOnly": true,
"fundingUrl": "",
"fundingUrl": {
"GitHub": "https://github.com/sponsors/djayatillake"
},
"main": "main.js"
}