Skip to content

Commit

Permalink
Update README and bump up version
Browse files Browse the repository at this point in the history
  • Loading branch information
crybot committed Jul 8, 2023
1 parent ed1cac7 commit 025e713
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ This plugin allows you to automatically generate flashcards using Large Language
## Features
- OpenAI's `text-davinci-003` and `gpt-3.5-turbo` integrations through official APIs. You can add your api-key under the plugin settings and choose which language model to use.
- Generate flashcards from any open note by running the `Generate Flashcards` command from the command palette. The generated flashcards will be appended to the current note, under a new markdown header.
- Customize the separator to use for generating inline flashcards.

**Note**: As of today, the plugin works with [obsidian-spaced-repetition](https://github.com/st3v3nmw/obsidian-spaced-repetition) in mind, with the default formatting settings. The plugin will only generate inline flashcards with the format *Q::A*. Future updates will make this customizable through the settings.
**Note**: The plugin works with [obsidian-spaced-repetition](https://github.com/st3v3nmw/obsidian-spaced-repetition) in mind. As of today it can only generate inline flashcards in the format that you choose. Future updates will make more customizations available (including multiline flashcards, reversed flashcards and more).

## Demo
<img src="https://github.com/crybot/obsidian-flashcards-llm/blob/master/docs/flashcards.gif">
Expand Down
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "flashcards-llm",
"name": "Flashcards LLM",
"version": "0.0.3",
"version": "0.0.4",
"minAppVersion": "0.15.0",
"description": "Use Large Language Models (such as ChatGPT) to automatically generate flashcards from obsidian notes",
"author": "Marco Pampaloni",
Expand Down
2 changes: 1 addition & 1 deletion versions.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"0.0.3": "0.15.0"
"0.0.4": "0.15.0"
}

0 comments on commit 025e713

Please sign in to comment.