Modernize README

README.md

@@ -1,32 +1,127 @@
+<h1 align="center">
+  <br>
+  <a href="https://github.com/Mudlet/Mudlet"><img src="https://bazaar.launchpad.net/~mudlet-makers/mudlet/artwork/download/head:/mudlet_main_256px.pn-20171109060211-hidv2woj9dffwyql-11/mudlet_main_256px.png" alt="Mudlet"></a>
+  <br>
+  Mudlet
+  <br>
+</h1>
+
+<h4 align="center">Play immersive, multiplayer, pure-text RPGs on Mudlet.</h4>
+
+<p align="center">
+  <a href="http://mudlet.org/download/">
+    <img src="https://travis-ci.org/Mudlet/Mudlet.svg?branch=development"
+         alt="Build status">
+  </a>
+  <a href="https://discord.gg/kuYvMQ9">
+    <img src="https://img.shields.io/badge/discord-join%20chat-7289DA.svg">
+  </a>
+  <a href="https://github.com/mudlet/mudlet/issues">
+    <img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat">
+  </a>
+  <a href="https://github.com/Mudlet/Mudlet/stargazers">
+    <img src="https://img.shields.io/github/stars/Mudlet/Mudlet.svg"/>
+  </a>
+</p>
+
+<p align="center">
+  <a href="#about">About</a> •
+  <a href="#key-features">Key Features</a> •
+  <a href="#how-to-use">How To Use</a> •
+  <a href="#download">Download</a> •
+  <a href="#credits">Credits</a> •
+  <a href="#roadmap">Roadmap</a> •
+  <a href="#license">License</a>
+</p>
+
+<p align="center">
+  <img alt="Interfaces players have created with Mudlet" height="500" src="https://bazaar.launchpad.net/~mudlet-makers/mudlet/artwork/download/head:/samplemudletuis.gif-20190701193442-s3gex5fzreha37jz-1/sample-mudlet-uis.gif">
+</p>
+
+## About
 
-# Mudlet
+Mudlet is a quality MUD client, designed to take mudding to a new level.
 
-[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/31fqq844br6g6i40/branch/development?svg=true)](https://ci.appveyor.com/project/Mudlet/mudlet/branch/development) [![GitHub Build Status](https://travis-ci.org/Mudlet/Mudlet.svg?branch=development)](https://travis-ci.org/Mudlet/Mudlet) [![GitHub stars](https://img.shields.io/github/stars/Mudlet/Mudlet.svg)](https://github.com/Mudlet/Mudlet/stargazers) [![Discord](https://img.shields.io/badge/discord-join%20chat-7289DA.svg)](https://discord.gg/kuYvMQ9)
+It’s a modern breed of a client on the gaming scene – with an intuitive user interface, a specially designed scripting framework, and a very fast text display. That, along with cross-platform capability and an open-source development model result in a very likable game client.
 
-Mudlet is a quality MUD client, designed to take mudding to a new level.
+## Key Features
 
-It’s a new breed of a client on the MUD scene – with an intuitive user interface, a specially designed scripting framework, and a very fast text display. That, along with cross-platform capability and an open-source development model result in a very likable MUD client.
+* Simple to use
+* Very, very fast
+* Active development
+* Big, thriving community
+* Poweful trigger engine
+* Backed by a thorough Lua engine
+* Excellent script editor
+* 2D and 3D mapper with autowalk
+* Powerful and simple to use GMCP
+* Discord integration
+* Completely themable
+* Open-source and Free
+* Cross platform
+  - Windows, macOS and Linux.
 
-## Easy to use client
+<details>
+  <summary>Explain?</summary>
+
+### Easy to use client
 
-We’re big on usability, and as such, creating an easy to use client and interface is one of the defining goals of the project. This applies to both the power users and plain gamers – everyone will feel at home with Mudlet, without having to waste too much time figuring out how to do something.
+We’re big on usability, and as such, creating an easy to use client and interface is one of the defining goals of the project. This applies to both the power users and usual gamers – everyone will feel at home with Mudlet, without having to waste too much time figuring out how to do something.
 
-## Designed for speed
+### Designed for speed
 
 Mudlet is designed and built to be very fast and efficient right from the start. Its scripting engine is designed to scale to large systems without bogging down – and the text display is designed to handle thousands of lines in under a second. All in all, we are very serious about Mudlet being quick – and take all measures to make it so.
 
-## Powerful Scripting
+### Powerful Scripting
 
 Mudlet features a scripting framework using [Lua](https://www.lua.org/) – a small, fast and efficient scripting language. This allows Mudlet to leverage the existing community and large ecosystem of existing packages for Lua without the many drawbacks of creating a Mudlet specific scripting language. Best of all, the Lua API is seamlessly integrated in Mudlet and shared by all aliases, triggers, scripts, keybindings, buttons and other Mudlet components.
 
-## Cross-Platform love
+### Cross-Platform love
+
+We believe in making Mudlet available to people on all major platforms, and we work on keeping cross-platform compatibility right from start. Mudlet is available on Linux (both 32bit and 64bit), Windows, and macOS; you may be able to run it on additional platforms as well.
+</details>
+
+## Download
+
+Download for free from [mudlet.org](https://www.mudlet.org/download/)
+
+## How To Use
+
+1. Download and double-click on Mudlet to run
+1. Pick an existing game and hit `Connect`
+1. ... or play one of your choosing:
+  1. Click `New`
+  1. Enter `Server address` and `Port` of your game (found on the game's website, e.g. `mygame.com` and `2003`)
+  1. Pick a `Profile name`
+  1. Hit `Connect`
+
+## Roadmap
+
+See the [project's roadmap](https://www.mudlet.org/2018/02/mudlet-roadmap-2018) to get an idea of where it's headed, as well as contribute!
+
+## Credits
+
+Author: [Mudlet Makers](https://github.com/Mudlet/Mudlet/graphs/contributors). Join in, contributions are welcome!
+
+This software wouldnt've been possible without these open source packages:
+
+- [Qt](https://www.qt.io/)
+- [Lua](https://www.lua.org/)
+- [edbee](http://www.edbee.net/)
+- [DBLSQD](https://www.dblsqd.com/)
+- [Communi](https://communi.github.io/)
+- [PCRE](https://www.pcre.org/)
+- [lua-yajl](https://github.com/brimworks/lua-yajl)
+- [Hunspell](https://hunspell.github.io/)
+
+Credit to [Markdownify](https://github.com/amitmerchant1990/electron-markdownify) for the README inspiration.
 
-We believe in making Mudlet available to people on all major platforms, and we work on keeping cross-platform compatibility right from start. Mudlet is available on Linux (both 32bit and 64bit), Windows, and Macs; work is currently in progress by one interested developer to add support for FreeBSD as a secondary platform i.e. we think it will work but the testing may be limited and *your milage may vary*.
+## License
 
-## And many other things…
+GPL2+
 
-Such as package creation / sharing, 3D mapper, and a moddable UI. You’re welcome to suggest new ideas and contribute code, too!
+---
 
-## Compiling
+> [website](https://www.mudlet.org/) &nbsp;&middot;&nbsp;
+> [forums](https://forums.mudlet.org/)
 
-Please see the [compiling page](https://wiki.mudlet.org/w/Compiling_Mudlet) on how to compile Mudlet on multiple platforms: Windows, macOS, and Linux OS.