Skip to content

Commit

Permalink
docs: add guide for using the plugin with BRAT
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianWoelki committed Jul 5, 2024
1 parent 967169a commit 0abff2f
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,19 @@ Things to do before release:
- [ ] Add settings view for customizing Anki algorithm parameters
- [x] Test and adapt to mobile experience

## Use the plugin before the release?

I am still actively developing this plugin, but I have not yet submitted it to Obsidian.
However, you can still use the plugin using **BRAT**:

1. Open Obsidian and go to the community plugins tab.
2. Search for **BRAT** and install it.
3. Click on the **Add Beta Plugin** button.
4. Paste the plugin link: https://github.com/FlorianWoelki/obsidian-better-recall
5. Click **Add Plugin**.

*Disclaimer: Things can break while in active development. Feel free to report any issues or bugs.*

## Development

To customize this project for your needs, you can clone it and then install all dependencies:
Expand Down

0 comments on commit 0abff2f

Please sign in to comment.