Skip to content

Commit

Permalink
feat: added links to DEPENDENCIES files in NOTICE and Helm and App ve…
Browse files Browse the repository at this point in the history
…rsion in READEME file to be compliant with Quality Checks
  • Loading branch information
dsrparracho committed Jul 7, 2023
1 parent dd30d63 commit ca44496
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 2 deletions.
2 changes: 1 addition & 1 deletion NOTICE.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The project maintains the following source code repositories in the GitHub organ

This project leverages the following third party content.

See DEPENDENCIES_BACKEND and DEPENDENCIES_FRONTEND file.
See [DEPENDENCIES_BACKEND](/DEPENDENCIES_BACKEND) and [DEPENDENCIES_FRONTEND](/DEPENDENCIES_FRONTEND) file.

## Cryptography

Expand Down
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,23 @@

<h1 style="display:flex; align-items: center;"><img src="./docs/catena-x-logo.svg"/>&nbsp;&nbsp;Digital Product Pass Application</h1>

## What is digital product passport application?
[![Contributors][contributors-shield]][contributors-url]
[![Stargazers][stars-shield]][stars-url]
[![Apache 2.0 License][license-shield]][license-url]
[![Latest Release][release-shield]][release-url]

## Description

The digital product passport application provides a consumer user interface to request a battery passport from a battery manufacturer using the standardized components and technologies in a Catena-X network. The passport will be displayed in a human-readable from any browser. The data exchange standards given by Catena-X are used to provide the battery passport to different personas (roles) in the network.

In particular, the appliction is used to access the battery passport data provided by battery manufacturer. By scanning QR-code or knowing the manufacturer and battery-ID, a user can request the passport through **Eclipse Dataspace Connectors (EDCs)** over the Catena-X network. The passport provider will provide data attributes that is only visible to a permitted signed-in user.

### Software Version
```shell
Latest Helm version is v3.12.0
Latest Application version is v1.0.0-alpha
```

## Application Preview

Here is a preview from the DPP App UI, where we visualize a test battery passport in this case.
Expand Down Expand Up @@ -55,6 +66,9 @@ To get started you can have a look into our documentation:
| [End User Manual](./docs/user%20manual/User%20Manual%20Product%20Viewer%20App.md) | End User Manual Product Viewer App |
| [Postman Overview](./postman/README.md) | Technical guide depicts the battery pass end-to-end API calls through the postman REST client |
| [Changelog](./CHANGELOG.md) | Changelog |
| [Helm Charts](https://github.com/eclipse-tractusx/digital-product-pass/tree/main/charts/digital-product-pass) | Project's Helm Charts |



### Prerequisites:

Expand Down Expand Up @@ -130,3 +144,23 @@ See [VSCode configuration](https://code.visualstudio.com/docs/getstarted/setting
## License

[Apache-2.0](https://raw.githubusercontent.com/eclipse-tractusx/digital-product-pass/digital-product-pass/main/LICENSE)


<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

[contributors-shield]: https://img.shields.io/github/contributors/eclipse-tractusx/digital-product-pass.svg?style=for-the-badge

[contributors-url]: https://github.com/eclipse-tractusx/digital-product-pass/graphs/contributors

[stars-shield]: https://img.shields.io/github/stars/eclipse-tractusx/digital-product-pass.svg?style=for-the-badge

[stars-url]: https://github.com/eclipse-tractusx/digital-product-pass/stargazers

[license-shield]: https://img.shields.io/github/license/eclipse-tractusx/digital-product-pass.svg?style=for-the-badge

[license-url]: https://github.com/eclipse-tractusx/digital-product-pass/blob/main/LICENSE

[release-shield]: https://img.shields.io/github/v/release/eclipse-tractusx/digital-product-pass.svg?style=for-the-badge

[release-url]: https://github.com/eclipse-tractusx/digital-product-pass/releases

0 comments on commit ca44496

Please sign in to comment.