Commit 51d59447 authored by m_goet09's avatar m_goet09

corrections

parent 17e213a8
......@@ -53,8 +53,8 @@
The badges aim to display the state of key factors about the research such that the output is very evident and presented right at the face of it.</p>
<p>The results are presented in an interactive manner that gives the display of the badge an even better meaning.
The results are provided with a certain colored background which depends on the type of output. For example a positive result is shown with a Green color,
a negative result is shown with a Red color and intermediate results are sometimes in Yellow or Orange color, again depending upon the specific type of outcome.</p>
The results are provided with a certain colored background which depends on the type of output. For example a positive result is shown with a green color,
a negative result is shown with a red color and intermediate results are sometimes in yellow or orange color, again depending upon the specific type of outcome.</p>
<p>In this project key aspects about a research that a user is interested in knowing are represented evidently on the badges.
For example a user might want to know if a research is peer-reviewed or not, in order to get an idea about the quality of the research.
......@@ -66,13 +66,15 @@
Badges provide a concise, recognizable yet useful piece of information, such as the build state or the number of downloads.
</p>
<h2>Our API</h2>
<p>There is part of API that is same for every task. That base part is as following:</p>
<p>There is a part of the API that is the same for every task. That base part is as following:</p>
<p>/api/1.0/badge</p>
<p>The rest of the API is case dependent. The structure would be dependent on the name of the task, platform from which metadata of a research is taken,
the id for calling a particular research compendium and a final addition which is optional in case you want to request a big badge, is the keyword "extended".
Example APIs are provided below:</p>
<p>This is an example from the licensing task:</p>
<p>/api/1.0/badge/licence/o2r/id/extended (returns a big badge)</p>
......@@ -82,7 +84,7 @@
<img src="images/shields_io/licence_partially_open.svg" /></br></br>
<p>This is an example from the licensing task. Let us have a look at another example from the executibility task:</p>
<p>This is an example from the executibility task:</p>
<p>/api/1.0/badge/executable/o2r/id/extended (returns a big badge)</p>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment