diff --git a/README.md b/README.md index e83f0f6..642c5c2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,21 @@ -node-minecraft-server -============== +Minecraft Server +================ +[![Minecraft version](https://img.shields.io/badge/minecraft%20version-1.8-brightgreen.svg)](http://wiki.vg/Protocol) +![Github issues](https://img.shields.io/github/issues/mhsjlw/node-minecraft-server.svg) +[![Build Status](https://img.shields.io/circleci/project/mhsjlw/node-minecraft-server/master.svg)](https://circleci.com/gh/mhsjlw/node-minecraft-server) [![Gratipay](https://img.shields.io/gratipay/mhsjlw.svg)](https://gratipay.com/~mhsjlw/) -This is a Minecraft server written in node.js for minecraft 1.8 +A semi-functional minecraft server in Node.js +## Building / Running + npm install + node app.js + +## Documentation +Documentation for how to operate and how to customize your server are coming soon! + +## Contributors + + - @roblabla for helping out with the protocols + - The PrismarineJS team for creating prismarine-chunk and node-minecraft-protcol + - [wiki.vg](http://wiki.vg/Protocols) for documenting minecraft protocols