Merge pull request #1 from open-spaced-repetition/update-ownership-info

Update ownership info
open-spaced-repetition · Oct 27, 2024 · dcc940a · dcc940a
2 parents dba3b4a + be8049a
commit dcc940a
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 9 deletions.
diff --git 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
@@ -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
@@ -1,6 +1,30 @@
-# leitner-box
-
-Python package implementing the [Leitner system](https://en.wikipedia.org/wiki/Leitner_system) for spaced repetition scheduling.
+<div align="center">
+  <img src="https://avatars.githubusercontent.com/u/96821265?s=200&v=4" height="100" alt="Open Spaced Repetition logo"/>
+</div>
+<div align="center">
+
+# Leitner Box
+</div>
+
+<div align="center">
+  <em>📦🔄 Build your own Leitner System in Python 📦🔄</em>
+</div>
+<br />
+<div align="center" style="text-decoration: none;">
+    <a href="https://pypi.org/project/leitner-box/"><img src="https://img.shields.io/pypi/v/leitner-box"></a>
+    <a href="https://github.com/open-spaced-repetition/leitner-box/blob/main/LICENSE" style="text-decoration: none;"><img src="https://img.shields.io/badge/License-MIT-brightgreen.svg"></a>
+</div>
+<br />
+
+<div align="center">
+    <strong>
+    Python package implementing the <a href="https://en.wikipedia.org/wiki/Leitner_system">Leitner system</a> for spaced repetition scheduling.
+    </strong>
+</div>
+
+<div align="center">
+    <img src="leitner-system.svg" height="300"/>
+</div>
 
 ## 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!
+Checkout [CONTRIBUTING](https://github.com/open-spaced-repetition/leitner-box/blob/main/CONTRIBUTING.md) to help improve leitner-box!
diff --git a/leitner-system.svg b/leitner-system.svg
diff --git 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 = "[email protected]" }]
@@ -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"