Skip to content

Commit

Permalink
update readme and action title
Browse files Browse the repository at this point in the history
  • Loading branch information
felixriehm committed Mar 6, 2024
1 parent b9bd9bd commit 870339b
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,26 @@
Certifies your code or documents by certifying the commit hash,
that triggered the GitHub action, on the bloxberg blockchain.

Development: Run `npm run all` before pushing code on GitHub.
## Development
Run `npm run all` before pushing code to this repository.

## Usage
An example on how to use this GitHub action can be viewed [here](https://github.com/bloxberg-org/bloxberg-certify-github-action/blob/main/.github/workflows/ci.yml).

### Available inputs
| Input | Description |
|-----------------|------------------------------------------------------------------------------|
| authorName | Your group or author(s) research was conducted with. |
| bloxbergAddress | Your bloxberg address that you would like the certification to be minted to. |
| researchTitle | A brief description of what the data entails. |
| email | An email address to be associated with the data. |

### Available outputs
| Output | Description |
|-------------------------|-----------------------------------------------------------------------|
| certificateVerification | JSON data to verify the certificate on https://certify.bloxberg.org/. |



## Additional notes
Code based on https://github.com/actions/typescript-action/.
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: 'Bloxberg certify'
name: 'Bloxberg certifier'
description: 'Certifies your code or documents'
author: 'Max Planck Digital Library'

Expand Down

0 comments on commit 870339b

Please sign in to comment.