aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-05-15 16:47:19 +0000
committerFuwn <[email protected]>2021-05-15 16:47:19 +0000
commit158848c7819595671497c896743ff388966c52b7 (patch)
tree8cf5d285ad0283fde0f7701ff4c6d8797fd88f9f /README.md
parentfix(readme.rst): remove extra padding on h1 (diff)
downloadwhirl-158848c7819595671497c896743ff388966c52b7.tar.xz
whirl-158848c7819595671497c896743ff388966c52b7.zip
refactor(readme): rst becomes new main readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md58
1 files changed, 0 insertions, 58 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index 66575cb..0000000
--- a/README.md
+++ /dev/null
@@ -1,58 +0,0 @@
-<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">
-The Open-Source WorldServer.
-</h1>
-
-<p align="center">
-<a href="https://discord.com/invite/8hn6padWF6">
-<img src="https://img.shields.io/discord/821938182274154506" alt="Discord" />
-</a>
-<a href="https://www.codefactor.io/repository/github/whirlsplash/whirl">
-<img src="https://www.codefactor.io/repository/github/whirlsplash/whirl/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/Whirlsplash/whirl" alt="License" />
-</a>
-</p>
-
-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>.
-
-## 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 a work-in-progress. As we begin to become more stable and add new features, we will release periodic updates regarding production use.
-
-## Documentation
-[https://whirlsplash.org/docs/](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)