doc(readme): create

1 files changed, 54 insertions, 0 deletions

diff --git a/README.rst b/README.rst
index e69de29..3445772 100644
--- a/README.rst
+++ b/README.rst
@@ -0,0 +1,54 @@
+senpy-rs
+========
+
+A wrapper of The Senpy Club API, which is a wrapper of the
+`cat-milk/Anime-Girls-Holding-Programming-Books <https://github.com/cat-milk/Anime-Girls-Holding-Programming-Books>`_
+repository.
+
+Quick links
+^^^^^^^^^^^
+
+.. raw:: html
+
+  <p>
+    <a href="https://discord.com/invite/yWKgRT6">
+      <img src="https://img.shields.io/discord/246524734718738442"
+           alt="Discord" />
+    </a>
+    <a href="https://www.codefactor.io/repository/github/senpy-club/senpy-rs">
+      <img src="https://www.codefactor.io/repository/github/senpy-club/senpy-rs/badge"
+           alt="CodeFactor" />
+    </a>
+    <a href="https://saythanks.io/to/[email protected]">
+      <img src="https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg"
+           alt="Say Thanks" />
+    </a>
+    <a href="LICENSE">
+      <img src="https://img.shields.io/github/license/senpy-club/senpy-rs"
+           alt="License" />
+    </a>
+    <a href="https://crates.io/crates/senpy">
+      <img src="https://img.shields.io/crates/v/senpy.svg"
+           alt="Crate" />
+    </a>
+    <a href="https://docs.rs/senpy">
+      <img src="https://docs.rs/senpy/badge.svg"
+           alt="Documentation" />
+    </a>
+    <a href="https://github.com/senpy-club/api-worker/actions/workflows/check.yaml">
+      <img src="https://github.com/senpy-club/api-worker/actions/workflows/check.yaml/badge.svg?branch=main"
+           alt="Build Status" />
+    </a>
+  </p>
+
+Examples
+--------
+
+.. raw:: html
+
+  Examples can be found within the <a href="./examples"><code>examples/</code></a> directory.
+
+License
+^^^^^^^
+
+`GNU General Public License v3.0 <https://github.com/senpy-club/senpy-rs/blob/main/LICENSE>`_