Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
crybot authored May 25, 2024
1 parent 94cbc6b commit c31769b
Showing 1 changed file with 29 additions and 7 deletions.
36 changes: 29 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,37 @@
# Obsidian Flashcards LLM

This plugin allows you to automatically generate flashcards using Large Language Models (such as OpenAI's GPT*) from within Obsidian.
This plugin integrates Large Language Models with Obsidian to help you generate flashcards from your notes. By leveraging OpenAI's models, such as GPT-3.5 and GPT-4, you can streamline your study process directly within Obsidian.

## News
- **New Integration**: The plugin now integrates with the latest OpenAI model, `gpt-4o`.

## 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.
- You can select which part of the document you want to generate the flashcards from, or you can use the entire note.
- Customize the separator to use for generating inline flashcards.

**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).
### Integration with OpenAI
- **Multiple Models**: Supports `text-davinci-003`, `gpt-3.5-turbo`, `gpt-4`, `gpt-4-turbo`, and `gpt-4o`. Configure your OpenAI API key in the plugin settings and select the desired model.
- **Flashcard Generation**: Generate flashcards from any open note using the `Generate Flashcards` command. The flashcards are appended to your note under a new markdown header.

### Customization Options
- **Selective Content Generation**: Choose to generate flashcards from a specific section of your note or the entire note.
- **Custom Prompts and Quantity**: Provide specific prompts and determine the number of flashcards to generate.
- **Inline Flashcards**: Customize the separator used for generating inline flashcards to match your preferred format.

### Future Plans
- **Expanded Flashcard Types**: Upcoming updates will support multiline flashcards, reversed flashcards, and additional customization options.

## Compatibility
- **Integration with Obsidian-Spaced-Repetition**: This plugin is designed to work with the [obsidian-spaced-repetition](https://github.com/st3v3nmw/obsidian-spaced-repetition) plugin, ensuring seamless integration of generated flashcards into your study routine.

## Demo
<img src="https://github.com/crybot/obsidian-flashcards-llm/blob/master/docs/flashcards.gif">
Check out this demo to see the plugin in action:
![Flashcards Demo](https://github.com/crybot/obsidian-flashcards-llm/blob/master/docs/flashcards.gif)

Try Obsidian Flashcards LLM and transform your notes into a structured study tool. Contributions, feedback, and suggestions are always welcome!

## Support
If you find this plugin helpful and want to support its development, consider sponsoring me:

[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-FFDD00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black)](https://bmc.link/crybot)
[![GitHub Sponsor](https://img.shields.io/badge/GitHub%20Sponsor-171515?style=for-the-badge&logo=github&logoColor=white)](https://github.com/sponsors/crybot)


0 comments on commit c31769b

Please sign in to comment.