aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-03-17 19:46:15 -0700
committerGitHub <[email protected]>2021-03-17 19:46:15 -0700
commit9727e76d1d7c2b32740e3c2542d8d7b225ccd26f (patch)
tree94d62f9a4de7ad7bffc207045f4e6dd1e0a5798f
parentCreate MAINTAINERS (diff)
downloadwhirl-9727e76d1d7c2b32740e3c2542d8d7b225ccd26f.tar.xz
whirl-9727e76d1d7c2b32740e3c2542d8d7b225ccd26f.zip
chore: spice up readme.
-rw-r--r--README.md29
1 files changed, 27 insertions, 2 deletions
diff --git a/README.md b/README.md
index 8696ecd..c9bab81 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,27 @@
-# Whirl
-Whirl, an open-source [worldserver](http://dev.worlds.net/private/GammaDocs/WorldServer.html) implementation in [Rust](https://www.rust-lang.org/).
+<p align="center">
+ <a href="https://github.com/Whirlsplash/whirl">
+ <img src="https://raw.githubusercontent.com/Whirlsplash/assets/master/Whirl.png" alt="Whirl icon" width="220" />
+ </a>
+</p>
+<h1 align="center">
+ Whirl, an open-source <a href="http://dev.worlds.net/private/GammaDocs/WorldServer.html">WorldServer</a> implementation in <a href="https://www.rust-lang.org/">Rust.</a>
+</h1>
+
+## 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
+Work-in-progress.
+
+## Documentation
+Work-in-progress.
+
+## Contributing
+Work-in-progress.
+
+### License
+[GNU General Public License v3.0](./LICENSE)