refactor(readme): rst becomes new main readme

1 files changed, 90 insertions, 0 deletions

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..f190ca6
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,90 @@
+.. raw:: html
+
+  <p align="center">
+    <a href="https://github.com/Whirlsplash/whirl">
+      <img src="https://raw.githubusercontent.com/Whirlsplash/assets/master/Whirl.png"
+        alt="Whirl" width="220">
+    </a>
+  </p>
+  <h1 align="center">The Open-Source WorldServer.</h1>
+
+  <p align="center">
+
+.. image:: https://img.shields.io/discord/821938182274154506
+  :alt: Discord
+  :target: https://discord.com/invite/8hn6padWF6
+
+.. image:: https://www.codefactor.io/repository/github/whirlsplash/whirl/badge
+  :alt: CodeFactor
+  :target: https://www.codefactor.io/repository/github/whirlsplash/whirl
+
+.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
+  :alt: Say Thanks
+  :target: https://saythanks.io/to/[email protected]
+
+.. image:: https://img.shields.io/github/license/Whirlsplash/whirl
+  :alt: License
+  :target: ./LICENSE
+
+.. raw:: html
+
+  </p>
+
+Whirl, an open-source
+`WorldServer <http://dev.worlds.net/private/GammaDocs/WorldServer.html>`__
+implementation in `Rust <https://www.rust-lang.org/>`__.
+
+Purpose
+-------
+
+Two *main* reasons;
+
+1. Worlds' official servers are old, slowly deteriorating, and *probably unmaintained*.
+2. Worlds is **old**. The shutdown of the servers is inevitable.
+
+TLDR: To keep Worlds' legacy going for future generations.
+
+Usage
+-----
+
+Use in production environments is not recommended as this project is currently under heavy
+development.
+
+As stability increases, periodic updates regarding production use will be released.
+
+Documentation
+-------------
+
+https://whirlsplash.org/docs/
+
+Known issues
+------------
+
+-  https://github.com/Whirlsplash/whirl/issues/2
+
+Contributing
+------------
+
+Please reference the `contribution guidelines <./CONTRIBUTING.md>`__ of this repository.
+
+Development Dependencies
+------------------------
+
+Required
+~~~~~~~~
+
+-  `diesel\_cli <https://crates.io/crates/diesel_cli>`__
+-  `cargo-make <https://github.com/sagiegurari/cargo-make>`__
+
+Optional
+~~~~~~~~
+
+-  `cargo-watch <https://crates.io/crates/cargo-watch>`__
+
+*These development dependencies will automatically be satisfied if you are using the Nix shell
+configuration as provided.*
+
+License
+~~~~~~~
+
+`GNU General Public License v3.0 <./LICENSE>`__