diff options
| -rw-r--r-- | README.rst | 19 |
1 files changed, 11 insertions, 8 deletions
@@ -2,8 +2,10 @@ <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"> + <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> @@ -30,9 +32,9 @@ </p> -Whirl, an open-source +Whirl, an open-source implementation of the `WorldServer <http://dev.worlds.net/private/GammaDocs/WorldServer.html>`__ -implementation in `Rust <https://www.rust-lang.org/>`__. +protocol in `Rust <https://www.rust-lang.org/>`__. Purpose ------- @@ -42,22 +44,23 @@ 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. +**TLDR**: To keep Worlds' legacy going for future generations. Usage ----- -Use in production environments is not recommended as this project is currently under heavy +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. +As stability increases, periodic updates regarding production use will be released (via Discord or +blog). Documentation ------------- https://whirlsplash.org/docs/ -Known issues +Known Issues ------------ - https://github.com/Whirlsplash/whirl/issues/2 |