Create README.md

Author: ITJesse

README.md

@@ -0,0 +1,22 @@
+# NyaaStats
+A user state page buider for Minecraft.
+
+# How to use
+You can simply build your own web pages, just following this instruction.
+
+## First grab user data from map folder
+1. Clone the project.
+2. `npm install`.
+3. Rename config.example.yml to config.yml and modify it.
+4. Run `npm start`. This will take long time to grab the informations for each user, be patient.
+
+## Build skin render
+1. Go into `skin` folder.
+2. `npm install && npm run build`.
+
+## Build web pages
+1. Go into `web` folder.
+2. `npm install && npm run build`.
+
+## That's all
+Now you can find all the files you need in the `web/dist` folder. Upload them to you server.