README for badge server (#117)

Author: liyanhui1228

badge_server/README.rst

@@ -0,0 +1,32 @@
+Badge Server
+============
+
+    Displaying the compatibility status for your package as a Github Badge.
+
+Types of badges
+---------------
+
+1. Self Compatibility
+2. Compatibility with Google OSS Python packages
+3. Dependency version status
+
+Usage
+-----
+
+Adding the link of the badge image and badge target to your README file on
+Github like below:
+
+.. csv-table::
+   :header: "CHECK_TYPE", "RESULT"
+   :widths: 20, 30
+
+   "Self Compatibility", |self_compatibility|
+   "Google Compatibility", |google_compatibility|
+   "Dependency Version Status", |dependency_version_status|
+
+.. |self_compatibility| image:: http://35.226.8.89/self_compatibility_badge/image?package=compatibility_lib
+   :target: http://35.226.8.89/self_compatibility_badge/target?package=compatibility_lib
+.. |google_compatibility| image:: http://35.226.8.89/google_compatibility_badge/image?package=compatibility_lib
+   :target: http://35.226.8.89/google_compatibility_badge/target?package=compatibility_lib
+.. |dependency_version_status| image:: http://35.226.8.89/self_dependency_badge/image?package=compatibility_lib
+   :target: http://35.226.8.89/self_dependency_badge/target?package=compatibility_lib