Merge pull request #183 from kit-data-manager/dev

Dev

Author: maximiliani

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/Materials-Data-Science-and-Informatics/somesy
+    rev: "v0.4.2"
+    hooks:
+      - id: somesy

.storybook/preview-head.html

@@ -1,6 +1,6 @@
 <meta name="description" content="The pid-component is an easily extensible web component that can be used to display PIDs, ORCiDs, and possibly other identifiers in a user-friendly way. It is easily extensible to support other identifier types." key="desc" />
 <title>Storybook - pid-component</title>
-<script type='module' src='https://unpkg.com/@kit-data-manager/pid-component'></script>
+<!--<script type='module' src='https://unpkg.com/@kit-data-manager/pid-component'></script>-->
 
 <!--For testing only-->
-<!--<script type='module' src='./dist/pid-component/pid-component.esm.js'></script>-->
+<script type='module' src='./dist/pid-component/pid-component.esm.js'></script>

CITATION.cff

@@ -1,19 +1,10 @@
 cff-version: 1.2.0
-message: 'If you use this software, please cite it as below.'
-authors:
-- family-names: Inckmann
-  given-names: Maximilian
-  affiliation: Karlsruhe Institute of Technology (KIT)
-  email: maximilian.inckmann@kit.edu
-  orcid: https://orcid.org/0009-0005-2800-4833
-title: 'pid-component'
+message: If you use this software, please cite it using these metadata.
 type: software
+title: '@kit-data-manager/pid-component'
 abstract: The PID-Component is a web component that can be used to display PIDs, ORCiDs,
   and possibly other identifiers in a user-friendly way. It is easily extensible to
   support other identifier types.
-date-released: 2023-08-18
-repository-code: 'https://github.com/kit-data-manager/pid-component'
-license: Apache-2.0
 version: 0.1.0
 keywords:
 - stencil
@@ -32,9 +23,18 @@ keywords:
 - fairdata
 - fairdo
 - fairdigitalobject
-contact:
-- given-names: Maximilian
+authors:
+- family-names: Inckmann
+  affiliation: Karlsruhe Institute of Technology (KIT)
   email: maximilian.inckmann@kit.edu
   orcid: https://orcid.org/0009-0005-2800-4833
+  given-names: Maximilian
+contact:
+- family-names: Inckmann
   affiliation: Karlsruhe Institute of Technology (KIT)
-  family-names: Inckmann
+  email: maximilian.inckmann@kit.edu
+  orcid: https://orcid.org/0009-0005-2800-4833
+  given-names: Maximilian
+license: Apache-2.0
+repository-code: https://github.com/kit-data-manager/pid-component
+url: https://kit-data-manager.github.io/pid-component

README.md

@@ -14,7 +14,7 @@ By default, it is set to 1, which means that it will only render the first level
 You can prohibit unfolding of the component by setting the `current-level-of-subcomponents` to the same value as
 the `level-of-subcomponents` property.
 
-To use the component, import the package via [unpkg](https://unpkg.com/):
+To use the component, import the [npm-package](https://www.npmjs.com/package/@kit-data-manager/pid-component) via [unpkg](https://unpkg.com/):
 
 ```html
 

codemeta.json

@@ -17,7 +17,7 @@
       "affiliation": "Karlsruhe Institute of Technology (KIT)"
     }
   ],
-  "name": "pid-component",
+  "name": "@kit-data-manager/pid-component",
   "description": "The PID-Component is a web component that can be used to display PIDs, ORCiDs, and possibly other identifiers in a user-friendly way. It is easily extensible to support other identifier types.",
   "version": "0.1.0",
   "keywords": [
@@ -51,5 +51,8 @@
   "license": [
     "https://spdx.org/licenses/Apache-2.0"
   ],
-  "codeRepository": "https://github.com/kit-data-manager/pid-component"
+  "softwareHelp": "https://kit-data-manager.github.io/pid-component",
+  "codeRepository": "https://github.com/kit-data-manager/pid-component",
+  "buildInstructions": "https://kit-data-manager.github.io/pid-component",
+  "url": "https://kit-data-manager.github.io/pid-component"
 }

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "pid-component",
+  "name": "@kit-data-manager/pid-component",
   "version": "0.1.0",
   "license": "Apache-2.0",
   "description": "The PID-Component is a web component that can be used to display PIDs, ORCiDs, and possibly other identifiers in a user-friendly way. It is easily extensible to support other identifier types.",
@@ -93,5 +93,6 @@
       "email": "maximilian.inckmann@kit.edu",
       "url": "https://orcid.org/0009-0005-2800-4833"
     }
-  ]
-}
+  ],
+  "homepage": "https://kit-data-manager.github.io/pid-component"
+}

somesy.toml

@@ -1,9 +1,11 @@
 [project]
-name = "pid-component"
+name = "@kit-data-manager/pid-component"
 version = "0.1.0"
-description = "The PID-Component is a web component that can be used to display PIDs, ORCiDs, and possibly other identifiers in a user-friendly way. It is easily extensible to support other identifier types."
+description = "The PID-Component is a web component that can be used to evaluate and display FAIR Digital Objects, PIDs, ORCiDs, and possibly other identifiers in a user-friendly way. It is easily extensible to support other identifier types."
 license = "Apache-2.0"
 repository = "https://github.com/kit-data-manager/pid-component"
+homepage = "https://kit-data-manager.github.io/pid-component"
+documentation = "https://kit-data-manager.github.io/pid-component"
 keywords = [
   "stencil",
   "webcomponent",