added description to github readme and updated repo url

README.md

@@ -1,3 +1,7 @@
+# KerrGeoPy
+
+KerrGeoPy is a python implementation of the [KerrGeodesics](https://bhptoolkit.org/KerrGeodesics/) mathematica library. It is intended for use in computing orbital trajectories for extreme-mass-ratio inspirals (EMRIs). It implements the analytical solutions for plunging orbits from [Dyson and van de Meent](https://arxiv.org/abs/2302.03704), as well as solutions for stable orbits from [Fujita and Hikida](https://arxiv.org/abs/0906.1420). The library also provides a set of methods for computing constants of motion and orbital frequencies.
+
 ## Installation
 
 Install the latest version of kerrgeopy using pip
@@ -9,7 +13,7 @@ pip install kerrgeopy
 
 Kerrgeopy computes orbits in Boyer-Lindquist coordinates $(t,r,\theta,\phi)$. Let $M$ to represent the mass of the primary body and let $J$ represent its angular momentum. Working in geometrized units where $G=c=1$, stable bound orbits are parametrized using the following variables:
 
-$a$ - spin of the primary body 
+$a$ - spin of the primary body
 <br>
 $p$ - orbital semilatus rectum
 <br>

docs/source/conf.py

@@ -58,7 +58,7 @@
 html_theme = 'sphinx_book_theme'
 
 html_theme_options = {
-    "repository_url": "https://github.com/syp2001/KerrGeoPy",
+    "repository_url": "https://github.com/BlackHolePerturbationToolkit/KerrGeoPy",
     "use_repository_button": True,
     "navbar_end": ["navbar-icon-links"],
 }