Update readme for release

This commit is contained in:
Logan Yang 2023-04-12 23:01:57 -07:00
parent 3666767987
commit e096b8a425
4 changed files with 11 additions and 6 deletions

View file

@ -17,10 +17,21 @@ Take your note-taking game to the next level with the Obsidian Copilot Plugin!
- One-click using the active note as context, and start a discussion around it (currently only supports shorter notes)
- Set your own parameters like LLM temperature, max tokens, conversation context based on your need (**pls be mindful of the API cost**).
## Demo
Chat with ChatGPT, copy a message to note, or save entire conversation as a note:
![Demo0](./images/demo0.gif)
QA around your past note:
![Demo1](./images/demo1.gif)
The settings page
<img src="./images/settings-page.png" alt="Settings" width="500">
## Planned features (based on feedback)
- More standard prompts that can be used with commands
- User customized prompts
- Online prompt library access
- Add support for having unlimited context, i.e. QA against very long notes, a collection of notes or the entire vault
- Integration with ChatGPT plugins when I get access
## Note
@ -30,9 +41,3 @@ Take your note-taking game to the next level with the Obsidian Copilot Plugin!
- You can set a very long context in the setting "**Conversation turns in context**" if needed.
### Again, please always be mindful of the API cost if you use GPT-4 with a long context!
## Demo
(add gifs)
## Changelog
- v1.0.1: Initial release

BIN
images/demo0.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.9 MiB

BIN
images/demo1.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.3 MiB

BIN
images/settings-page.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 244 KiB