Merge pull request #103 from common-workflow-language/fix-doc-for-badges

mr-c · web-flow · commit 221e21ce8045 · 2020-01-20T08:34:43.000+01:00
Update the badge section in README.rst
diff --git a/README.rst b/README.rst
@@ -48,13 +48,13 @@ To generate JSON files::
   ...
   $ cat badges/command_line_tool.json | jq .
   {
-    "subject": "[CWL] command_line_tool",
+    "subject": "command_line_tool",
     "status": "100%",
     "color": "green"
   }
 
-Once you upload JSON file to a server, you make a badge by using a link like https://flat.badgen.net/https/path/to/generated/json.
+Once you upload JSON file to a server, you make a badge by using a link like https://badgen.net/https/path/to/generated/json or https://flat.badgen.net/https/path/to/generated/json (for flat badges).
 
 Here is an example of markdown to add a badge::
 
-  ![test result](https://flat.badgen.net/https/path/to/generated/json)
+  ![test result](https://flat.badgen.net/https/path/to/generated/json?icon=commonwl)

Original file line number	Diff line number	Diff line change
`@@ -48,13 +48,13 @@ To generate JSON files::`
`48`	`48`	`...`
`49`	`49`	`$ cat badges/command_line_tool.json \| jq .`
`50`	`50`	`{`
`51`		`- "subject": "[CWL] command_line_tool",`
	`51`	`+ "subject": "command_line_tool",`
`52`	`52`	`"status": "100%",`
`53`	`53`	`"color": "green"`
`54`	`54`	`}`
`55`	`55`
`56`		`-Once you upload JSON file to a server, you make a badge by using a link like https://flat.badgen.net/https/path/to/generated/json.`
	`56`	`+Once you upload JSON file to a server, you make a badge by using a link like https://badgen.net/https/path/to/generated/json or https://flat.badgen.net/https/path/to/generated/json (for flat badges).`
`57`	`57`
`58`	`58`	`Here is an example of markdown to add a badge::`
`59`	`59`
`60`		`- ![test result](https://flat.badgen.net/https/path/to/generated/json)`
	`60`	`+ ![test result](https://flat.badgen.net/https/path/to/generated/json?icon=commonwl)`