Skip to content
This repository was archived by the owner on Oct 21, 2022. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 26 additions & 7 deletions badge_server/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,38 @@ Usage
-----

Adding the link of the badge image and badge target to your README file on
Github like below:
Github:

.. code-block::

.. 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

And the badges will show up 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", |self_compat|
"Google Compatibility", |google_compat|
"Dependency Version Status", |dep_version_status|

.. |self_compatibility| image:: http://35.226.8.89/self_compatibility_badge/image?package=compatibility_lib
.. |self_compat| 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
.. |google_compat| 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
.. |dep_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
2 changes: 1 addition & 1 deletion badge_server/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
compatibility_lib==0.0.6
compatibility_lib>=0.0.7
Flask==1.0.2
google-cloud-bigquery==1.3.0
redis==2.10.5
Expand Down