mirror of
https://github.com/aurelienstebe/Gladdis.git
synced 2026-07-22 08:40:27 +00:00
docs: update README with screenshots and demo Vault link
This commit is contained in:
parent
cc4a2d1e6e
commit
88538bb98e
3 changed files with 15 additions and 3 deletions
18
README.md
18
README.md
|
|
@ -12,9 +12,17 @@
|
|||
- **Whisper Transcription**: audio files WikiLinks are auto-transcribed, use the Obsidian "audio recorder" core plugin.
|
||||
- **Document Loading**: text files WikiLinks are auto-loaded, just drag and drop files into the conversation window.
|
||||
- **PDF & Web Support**: load PDF WikiLinks just like text files, load web pages external links as well using `<URL>`.
|
||||
- **Image Vision AIs**: send images to vision supporting LLMs using local WikiLinks or Markdown external web links.
|
||||
- **Image Vision AIs**: send images to vision-supporting LLMs using local WikiLinks or Markdown external web links.
|
||||
- **System Prompts**: name your system prompts, create personalities and use FrontMatter to choose whom to talk to.
|
||||
|
||||
## Plugin Demo Vault
|
||||
|
||||
Download the [Plugin Demo Vault in ZIP or TGZ](https://github.com/AurelienStebe/Gladdis/releases/latest) to try it out !
|
||||
|
||||
<br>
|
||||
|
||||

|
||||
|
||||
## Documentation
|
||||
|
||||
### Obsidian Commands
|
||||
|
|
@ -27,12 +35,16 @@ Gladdis provides 3 commands, map them to hotkeys in the settings or create butto
|
|||
|
||||
### Settings / Options
|
||||
|
||||
The settings panel let you specify the plugin data folder, your OpenAI API key and the FrontMatter defaults.
|
||||
The settings panel lets you specify the plugin data folder, your OpenAI API key, and the FrontMatter defaults.
|
||||
|
||||
- **Data Root Path**: Gladdis will search for config files in the `configs` subfolder, and will write the chat and call logs in the `history` subfolder.
|
||||
- **OpenAI Secret Key**: create an OpenAI API account, [generate an API key](https://platform.openai.com/account/api-keys) and paste it in the settings panel.
|
||||
- **FrontMatter Defaults**: adjust the various defaults for the Gladdis and Whisper options.
|
||||
|
||||
<br>
|
||||
|
||||

|
||||
|
||||
### FrontMatter Config
|
||||
|
||||
The defaults from the settings panel can be overridden using FrontMatter in any conversation or config file.
|
||||
|
|
@ -93,7 +105,7 @@ The following [OpenAI models](https://platform.openai.com/docs/models) are suppo
|
|||
| `gpt-4-turbo` | 128 k | ✅ | The latest GPT-4 Turbo model with vision capabilities (GPT-4o is cheaper and faster). |
|
||||
| `gpt-3.5-turbo` | 16 k | | The latest GPT-3.5 Turbo model with higher accuracy (GPT-4o mini is cheaper and more capable). |
|
||||
|
||||
Open Source models can be used locally via [Ollama](https://ollama.com/) or [LocalAI](https://localai.io/):
|
||||
Open-Source models can be used locally via [Ollama](https://ollama.com/) or [LocalAI](https://localai.io/):
|
||||
|
||||
| Label | Tokens | Vision | Notes |
|
||||
| ----------------- | :----: | :----: | ---------------------------------------------------------------------------- |
|
||||
|
|
|
|||
BIN
options.png
Normal file
BIN
options.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 171 KiB |
BIN
picdemo.png
Normal file
BIN
picdemo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 671 KiB |
Loading…
Reference in a new issue