Skip to content

Commit

Permalink
feat: Added information about component template usage
Browse files Browse the repository at this point in the history
  • Loading branch information
caviri committed Nov 13, 2024
1 parent de93897 commit 6be9f2c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
3 changes: 3 additions & 0 deletions README.template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

Add here your badges:
[![Launch in your ODTP](https://img.shields.io/badge/Launch%20in%20your-ODTP-blue?logo=launch)](http://localhost:8501/launch-component)
[![Compatible with ODTP v0.5.x](https://img.shields.io/badge/Compatible%20with-ODTP%20v0.5.0-green)]("")

> [!NOTE]
> This repository makes use of submodules. Therefore, when cloning it you need to include them.
Expand Down Expand Up @@ -139,3 +140,5 @@ docker run -it --rm \
## Credits and references

XXXXXXXXXX

This component has been created using the `odtp-component-template` `v0.5.0`.
8 changes: 4 additions & 4 deletions odtp.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@ schema-version: "v0.5.0"

# Component Information
component-name: Component Name
component-version: "vX.Y.Z"
component-license: Component License
component-type: ephemeral or interactive
component-description: Description of the component's function
component-authors:
- name: Author One
orcid: "https://orcid.org/0000-0001-2345-6789"
- name: Author Two
orcid: "https://orcid.org/0000-0002-3456-7890"
component-version: "1.0.0"
component-repository:
url: "https://github.com/organization/component-repo"
doi: "https://doi.org/10.1234/component.doi"
component-license: Component License
component-type: ephemeral or interactive
component-description: Description of the component's function
component-docker-image: "dockeruser/dockerimage:label"
tags:
- tag1
Expand Down

0 comments on commit 6be9f2c

Please sign in to comment.