Add GitHub star suggestion

Gotta respect the hustle...
mhostetter · Dec 10, 2022 · 253ce89 · 253ce89
1 parent 41dcc7d
commit 253ce89
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -19,6 +19,8 @@
 
 The `galois` library is a Python 3 package that extends NumPy arrays to operate over finite fields.
 
+> Enjoying the library? Give us a :star: on [GitHub](https://github.com/mhostetter/galois)!
+
 The user creates a [`FieldArray`](https://mhostetter.github.io/galois/latest/api/galois.FieldArray/) subclass using `GF = galois.GF(p**m)`.
 `GF` is a subclass of `np.ndarray` and its constructor `x = GF(array_like)` mimics the signature of `np.array()`. The
 [`FieldArray`](https://mhostetter.github.io/galois/latest/api/galois.FieldArray/) `x` is operated on like any other NumPy array except

diff --git a/docs/conf.py b/docs/conf.py
@@ -272,6 +272,11 @@
         "icon": "fontawesome/regular/eye",
         "override": True,
     },
+    {
+        "name": "star",
+        "icon": "octicons/star-fill-24",
+        "color": (255, 233, 3),  # Gold
+    },
 ]
 
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,6 +3,11 @@
 
 The :obj:`galois` library is a Python 3 package that extends NumPy arrays to operate over finite fields.
 
+.. star:: Enjoying the library? Give us a :si-icon:`octicons/star-fill-24` on `GitHub <https://github.com/mhostetter/galois>`_!
+   :collapsible:
+
+   Help others find this library too!
+
 The user creates a :obj:`~galois.FieldArray` subclass using `GF = galois.GF(p**m)`. `GF` is a subclass of :obj:`numpy.ndarray`
 and its constructor `x = GF(array_like)` mimics the signature of :func:`numpy.array`. The :obj:`~galois.FieldArray` `x` is operated
 on like any other NumPy array except all arithmetic is performed in :math:`\mathrm{GF}(p^m)`, not :math:`\mathbb{R}`.