diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f02dd88..8d82c46 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,12 +8,12 @@ In this short guide, you will get a quick overview of how you can contribute to If you encounter an issue with leitner-box and would like to report it, you'll first want to make sure you're using the latest version of leitner-box. -The latest version of leitner-box can be found under [releases](https://github.com/joshdavham/leitner-box/releases) and you can verify the version of your current installation with the following command: +The latest version of leitner-box can be found under [releases](https://github.com/open-spaced-repetition/leitner-box/releases) and you can verify the version of your current installation with the following command: ``` pip show leitner-box ``` -Once you've confirmed your version, please report your issue in the [issues tab](https://github.com/joshdavham/leitner-box/issues). +Once you've confirmed your version, please report your issue in the [issues tab](https://github.com/open-spaced-repetition/leitner-box/issues). ## Contributing code diff --git a/LICENSE b/LICENSE index 1b4cb91..0a2e802 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2024 Joshua Hamilton +Copyright (c) 2024 Open Spaced Repetition Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index d27b4e3..3061f30 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,30 @@ -# leitner-box - -Python package implementing the [Leitner system](https://en.wikipedia.org/wiki/Leitner_system) for spaced repetition scheduling. +
+ Open Spaced Repetition logo +
+
+ +# Leitner Box +
+ +
+ 📦🔄 Build your own Leitner System in Python 📦🔄 +
+
+
+ + +
+
+ +
+ + Python package implementing the Leitner system for spaced repetition scheduling. + +
+ +
+ +
## Installation @@ -184,4 +208,4 @@ Once this package is considered stable, the **Major** version will be bumped to ## Contribute -Checkout [CONTRIBUTING](https://github.com/joshdavham/leitner-box/blob/main/CONTRIBUTING.md) to help improve leitner-box! \ No newline at end of file +Checkout [CONTRIBUTING](https://github.com/open-spaced-repetition/leitner-box/blob/main/CONTRIBUTING.md) to help improve leitner-box! \ No newline at end of file diff --git a/leitner-system.svg b/leitner-system.svg new file mode 100644 index 0000000..3fb150a --- /dev/null +++ b/leitner-system.svg @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/pyproject.toml b/pyproject.toml index 7e7b459..43d8267 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "leitner_box" -version = "0.1.0" +version = "0.1.1" description = "Leitner system spaced repetition" readme = "README.md" authors = [{ name = "Joshua Hamilton", email = "hamiltonjoshuadavid@gmail.com" }] @@ -15,7 +15,7 @@ classifiers = [ "Operating System :: OS Independent" ] keywords=['leitner', 'spaced-repetition', 'flashcard'] -urls = { homepage = "https://github.com/joshdavham/leitner-box" } +urls = { homepage = "https://github.com/open-spaced-repetition/leitner-box" } dependencies = [] requires-python = ">=3.9"