Skip to content

Commit dc70d52

Browse files
authored
Merge pull request #105 from MOBSkuchen/correct-readme-md
Correct grammar and spelling mistakes in README.md
2 parents fcaff29 + bd06bc6 commit dc70d52

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
[![CI](https://github.com/Sphereon-Opensource/OID4VCI/actions/workflows/build-test-on-pr.yml/badge.svg)](https://github.com/Sphereon-Opensource/OID4VCI/actions/workflows/build-test-on-pr.yml) [![codecov](https://codecov.io/gh/Sphereon-Opensource/OID4VCI/branch/develop/graph/badge.svg)](https://codecov.io/gh/Sphereon-Opensource/OID4VCI) [![NPM Version](https://img.shields.io/npm/v/@sphereon/oid4vci-client.svg)](https://npm.im/@sphereon/oid4vci-client)
99

10-
_IMPORTANT the packages are still in an early development stage, as such breaking changes are to be expected_
10+
_IMPORTANT the packages are still in an early development stage, which means that breaking changes are to be expected_
1111

1212
# Background
1313

@@ -19,10 +19,10 @@ OpenID4VCI defines an API designated as Credential Endpoint that is used to issu
1919
corresponding OAuth 2.0 based authorization mechanisms (see [RFC6749]) that a Wallet uses to obtain authorization to
2020
receive verifiable credentials. W3C formats as well as other Credential formats are supported. This allows existing
2121
OAuth 2.0 deployments and OpenID Connect OPs (see [OpenID.Core]) to extend their service and become Credential Issuers.
22-
It also allows new applications built using Verifiable Credentials to utilize OAuth 2.0 as integration and
22+
It also allows new applications built using Verifiable Credentials to utilize OAuth 2.0 as an integration and
2323
interoperability layer. This package provides holder/wallet support to interact with OpenID4VCI capable Issuer systems.
2424

25-
Next to the client and issuer, there is also a common package, which has all the types and payloads shared between the client and issuer.
25+
In addition to the client and issuer, there is also a common package, which has all the types and payloads shared between the client and issuer.
2626

2727
# Packages
2828
There are 2 main packages in this mono-repository
@@ -34,7 +34,7 @@ The OpenID4VCI client is typically used in wallet type of applications, where th
3434
## OpenID for VCI Issuer
3535

3636
The OpenID4VCI issuer is used in issuer type applications, where an organization is issuing the credential(s). More info can be found in the issuer [README](./packages/issuer/README.md).
37-
Please not that the Issuer is a library. It has some examples how to run it with REST endpoints. If you however are looking for a full solution we suggest our [SSI SDK](https://github.com/Sphereon-Opensource/ssi-sdk) or the [demo](https://github.com/Sphereon-Opensource/OID4VC-demo)
37+
Please note that the Issuer is a library. It has some examples on how to run it with REST endpoints. If you are however looking for a full solution we suggest our [SSI SDK](https://github.com/Sphereon-Opensource/ssi-sdk) or the [demo](https://github.com/Sphereon-Opensource/OID4VC-demo)
3838

3939

4040
# Flows
@@ -47,9 +47,9 @@ This flow is supported but might need more work, so you might run into issues tr
4747

4848
## Pre-authorized Code Flow
4949

50-
The pre-authorized code flow assumes the user is using an out of bound mechanism outside the issuance flow to
50+
The pre-authorized code flow assumes that the user is using an out of bound mechanism outside the issuance flow to
5151
authenticate first.
5252

53-
The below diagram shows the steps involved in the pre-authorized code flow. Note that wallet inner functionalities (like
54-
saving VCs) are out of scope for this library. Also This library doesn't involve any functionalities of a VC Issuer
53+
The below diagram shows the steps involved in the pre-authorized code flow. Note that inner wallet functionalities (like
54+
saving VCs) are out of scope for this library. Also This library doesn't include any functionalities of a VC Issuer
5555
![Flow diagram](https://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/Sphereon-Opensource/OID4VCI-client/develop/docs/preauthorized-code-flow.puml)

0 commit comments

Comments
 (0)