fix: add contribution info (#66)

Signed-off-by: Mirko Mollik <[email protected]>

.vscode/settings.json

@@ -1,5 +1,5 @@
 {
-  "cSpell.words": ["keycloak", "siop", "sphereon"],
+  "cSpell.words": ["credhub", "keycloak", "openwallet", "siop", "sphereon"],
 
   "yaml.schemas": {
     "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+## How to contribute
+
+You are encouraged to contribute to the repository by **forking and submitting a pull request**.
+
+(If you are new to GitHub, you might start with a [basic tutorial](https://help.github.com/articles/set-up-git) and check out a more detailed guide to [pull requests](https://help.github.com/articles/using-pull-requests/).)
+
+Pull requests will be evaluated by the repository guardians on a schedule and if deemed beneficial will be committed to the main branch. Pull requests should have a descriptive name and include an summary of all changes made in the pull request description.
+
+If you would like to propose a significant change, please open an issue first to discuss the proposed changes with the community and to avoid re-work.
+
+Contributions are made pursuant to the Developer's Certificate of Origin, available at [https://developercertificate.org](https://developercertificate.org), and licensed under the Apache License, version 2.0 (Apache-2.0).

README.md

@@ -1,45 +1,12 @@
-# CredHub
+# credhub
 
-CredHub is comprehensive monorepo including a cloud wallet for natural persons together with a minimal issuer and verifier service. The cloud wallet will host all credentials and key pairs, including the business logic to receive and present credentials.
+credhub is comprehensive monorepo including a cloud wallet for natural persons together with a minimal issuer and verifier service. The cloud wallet will host all credentials and key pairs, including the business logic to receive and present credentials.
 
-# Why a cloud wallet
-A cloud wallet is able to move the whole complexity of the SSI algorithms to the server side, so the clients only need to render the data. This makes the development of new clients or integration into existing applications much easier. It also provides an equal security level for all users and does not exclude any smartphones because of their hardware capabilities. Besides that it allows the user to access his credentials from multiple devices without the need to sync them.
-
-Of course the user is losing offline capabilities and has to trust the server to not misuse personal data. But this is a tradeoff that can be acceptable for many use cases when you want to start with verifiable credentials with great user experience and low development effort.
-
-# Tech Stack
-- Programming language: Typescript, Node >= v18
-- NX as monorepo manager
-- Frontend-Framework: [Angular](https://angular.dev/)
-- Backend-Framework: [Nestjs](https://nestjs.com/)
-
-## Credential Profile
-The following algorithms were chosen. Instead of supporting as much as possible, we decided to focus on the architecture reference framework to be aligned with the EUDI Wallet projects.
-
-- Issuance and Presentation protocol: [Oid4vc](https://openid.net/sg/openid4vc/) for issuing and presenting credentials
-- credential format: [SD-JWT-VC](https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-03.html)
-- Signing algorithm: P-256
-- Key management holder: Json Web Key, cnf binding
-- Key management issuer: [JWT Issuer Metadata](https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-03.html#name-jwt-vc-issuer-metadata), X509 and DID will come soon
-- Status Management: [Token Status List](https://drafts.oauth.net/draft-ietf-oauth-status-list/draft-ietf-oauth-status-list.html)
-
-## Apps connection
-![Overview](https://www.mermaidchart.com/raw/832e87e0-a10e-40b3-b103-ed79ad860b6e?theme=light&version=v0.1&format=svg)
-
-## Issuance flow
-
-![Issuance process](https://www.mermaidchart.com/raw/36b70fe7-7b53-448a-8f65-2f29b1c515af?theme=light&version=v0.1&format=svg)
-
-## Presentation flow
-![Presentation flow](https://www.mermaidchart.com/raw/fd2e141e-9a29-43ee-b16f-2bafc701bbb0?theme=light&version=v0.1&format=svg)
-
-# More information
-- [Repo structure](./docs/repo-strucutre.md)
-- [Running docker images](./docs/running-docker.md)
-- [Development](./docs/development.md)
+# Getting Started
+Documentation on how to get started with credhub can be found at [https://credhub.eu](https://credhub.eu)
 
 # Contributing
-Contributions are always welcome. When opening a pull request, please make sure it is signed and explain the changes you made. In case you want to discuss about a new feature/change, open an issue and we can discuss it there.
+If you would like to contribute to the project, please read our [contributing guide](./CONTRIBUTING.md).
 
 # License
-This project is licensed under the Apache 2.0 License
+This project is licensed under the [Apache License Version 2.0 (Apache-2.0).](./LICENSE)

docs/index.md

@@ -1,6 +1,6 @@
-# CredHub
+# credhub
 
-CredHub is comprehensive monorepo including a cloud wallet for natural persons together with a minimal issuer and verifier service. The cloud wallet will host all credentials and key pairs, including the business logic to receive and present credentials.
+credhub is comprehensive monorepo including a cloud wallet for natural persons together with a minimal issuer and verifier service. The cloud wallet will host all credentials and key pairs, including the business logic to receive and present credentials.
 
 # License
 This project is licensed under the Apache 2.0 License

mkdocs.yml

@@ -1,4 +1,4 @@
-site_name: Credhub
+site_name: credhub
 repo_name: openwallet-foundation-labs/credhub
 repo_url: https://github.com/openwallet-foundation-labs/credhub
 edit_uri: edit/main/docs