Skip to content

Commit

Permalink
edit README and add links to other python packages
Browse files Browse the repository at this point in the history
  • Loading branch information
joshdavham committed Dec 13, 2024
1 parent ecc3ade commit 7f48fc3
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,10 @@ card = Card()
Choose a rating and review the card

```python
"""
Rating.Again # (==0) forgot the card
Rating.Hard # (==1) remembered the card, but with serious difficulty
Rating.Good # (==2) remembered the card after a hesitation
Rating.Easy # (==3) remembered the card easily
"""
# Rating.Again (==1) forgot the card
# Rating.Hard (==2) remembered the card with serious difficulty
# Rating.Good (==3) remembered the card after a hesitation
# Rating.Easy (==4) remembered the card easily

rating = Rating.Good

Expand Down Expand Up @@ -123,6 +121,12 @@ This python package is currently unstable and adheres to the following versionin

Once this package is considered stable, the **Major** version will be bumped to 1.0.0 and will follow [semver](https://semver.org/).

## Other SRS python packages

- [FSRS](https://github.com/open-spaced-repetition/py-fsrs)
- [SM-2](https://github.com/open-spaced-repetition/sm-2)
- [Leitner System](https://github.com/open-spaced-repetition/leitner-box)

## Contribute

Checkout [CONTRIBUTING](https://github.com/open-spaced-repetition/anki-sm-2/blob/main/CONTRIBUTING.md) to help improve Anki SM-2!
Expand Down

0 comments on commit 7f48fc3

Please sign in to comment.