Merge pull request #12 from YoshinoriN/issue/7

(refs #7) : Create README

Author: yoshinorin

README.md

@@ -1,4 +1,55 @@
 # gitbucket-monitoring-plugin
-WIP
 
 [![](https://travis-ci.org/YoshinoriN/gitbucket-monitoring-plugin.svg?branch=master)](https://travis-ci.org/YoshinoriN/gitbucket-monitoring-plugin) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/677a69ed2e5f4137ba35986dbb02995f)](https://www.codacy.com/app/YoshinoriN/gitbucket-monitoring-plugin?utm_source=github.com&utm_medium=referral&utm_content=YoshinoriN/gitbucket-monitoring-plugin&utm_campaign=Badge_Grade)
+
+# Features
+
+This plugin for display machine information, resources, processes, Java information and GitBucket's log for GitBucket Administrator.
+
+* Operating System Information (OS, Distribution, Version, Architecture)
+* Uptime (When booted, Spent time after booted)
+* Time (Now time, Time Zone, Zone offset, Day of Week)
+* Machine's enviroment valiables
+* Machine's resources (Cpu core, Cpu Usaga, Physical memory, Swap, Disk Usaga)
+* Machine's Load average
+* Machine's Tasks (Running, Sleepling, Stopped, Zombie)
+* Java system properties and memory
+* LogBack settings
+* GitBucket's log
+
+# Images
+
+![menu](/doc/images/menu.png)
+
+||||
+|:-------:|:-------:|:-------:|
+|![system](/doc/images/system.png)|![envval](/doc/images/envval.png)|![resources](/doc/images/resources.png)|
+|![process](/doc/images/process.png)|![java-p](/doc/images/java-p.png)|![java-m](/doc/images/java-m.png)|
+|![logback](/doc/images/logback.png)|![gitbucketlog](/doc/images/gitbucketlog.png)||
+
+# Download & Installation
+
+1. Download plugin jar file from [the release page](//github.com/YoshinoriN/gitbucket-monitoring-plugin/releases).
+2. Put plugin jar file into `GITBUCKET_HOME/plugins` and restart GitBucket.
+
+# Version
+
+|Plugin version|GitBucket version|
+|:-------------:|:-------:|
+|1.0.0|4.10, 4.11, 4.12.x |
+
+# Supported OS
+
+I confirm work it only `Debian GNU/Linux 8`, `Ubuntu 16.04` and `Windows10`.  But I think maybe also will be work it on other distribution(version) of Linux and Window. Mac is also.
+
+# Build from source
+
+```sh
+sbt package
+```
+
+The built package will be created at `/target/scala-2.12/gitbucket-monitorting-plugin_2.12-{plugin-version}.jar`
+
+# License
+
+This project is under the Apache License, Version 2.0 License. See the [LICENSE](./LICENSE) file for the full license text.