Skip to content

Commit

Permalink
docs: add how to use it section
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianWoelki committed Jul 15, 2024
1 parent 67c4a74 commit 6bee4d2
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

![Preview Image](./docs/preview-image.png)


## What is it?

This plugin allows you to have an Anki-like feeling in Obsidian.
Expand All @@ -11,6 +12,20 @@ The plugin integrates the following spaced-repetition algorithms:

- [Anki algorithm](https://faqs.ankiweb.net/what-spaced-repetition-algorithm.html)


## How to use it

Although everything with the plugin should be self-explanatory, here's a quick rundown of how to get started.

You can view your decks by clicking this sidebar icon:

![Preview Image](./docs/decks.png)

You can also access your created decks by executing the command `Better Recall: Recall`.

With that, you can create decks and cards and start your spaced-repetition journey.


## Use the plugin before the release?

I am still actively developing this plugin, but I have not yet submitted it to Obsidian.
Expand All @@ -24,6 +39,7 @@ However, you can still use the plugin using **BRAT**:

*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
Binary file added docs/decks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6bee4d2

Please sign in to comment.