Skip to content

Commit

Permalink
update for new release
Browse files Browse the repository at this point in the history
  • Loading branch information
jchartrand committed Oct 9, 2024
1 parent a91d51d commit 300b8e8
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# signing-service Changelog

## 1.0.0 - 2024-10-09

### Changed
- updating semver to reflect breaking change
- updated all libs to digitalcredentials to make use of fine grained logging
- **BREAKING**: The libs that were updated now require that the top level id on a verifiable credential must be a uri. Any old (or new) clients calling the endpoints on this service with a vc that doesn't have a uri id will fail.
- new libs support both VC1 and VC2 as well as bistring status list

## 0.4.0 - 2024-09-01
### Changed
- switch all libs to most recent versions of digitalbazaar, rather than digitalcredentials
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Build status](https://img.shields.io/github/actions/workflow/status/digitalcredentials/signing-service/main.yml?branch=main)](https://github.com/digitalcredentials/signing-service/actions?query=workflow%3A%22Node.js+CI%22)

IMPORTANT NOTE ABOUT VERSIONING: If you are using a Docker Hub image of this repository, make sure you are reading the version of this README that corresponds to your Docker Hub version. If, for example, you are using the image `digitalcredentials/status-service:0.1.0` then you'll want to use the corresponding tagged repo: [https://github.com/digitalcredentials/status-service/tree/v0.1.0](https://github.com/digitalcredentials/status-service/tree/v0.1.0). If you are new here, then just read on...
IMPORTANT NOTE ABOUT VERSIONING: If you are using a Docker Hub image of this repository, make sure you are reading the version of this README that corresponds to your Docker Hub version. If, for example, you are using the image `digitalcredentials/status-service:1.0.0` then you'll want to use the corresponding tagged repo: [https://github.com/digitalcredentials/status-service/tree/v1.0.0](https://github.com/digitalcredentials/status-service/tree/v0.1.0). If you are new here, then just read on...

## Table of Contents

Expand Down Expand Up @@ -30,7 +30,7 @@ IMPORTANT NOTE ABOUT VERSIONING: If you are using a Docker Hub image of this rep

## Summary

Use this express server to sign [Verifiable Credentials](https://www.w3.org/TR/vc-data-model/).
Use this express server to sign [Verifiable Credentials](https://www.w3.org/TR/vc-data-model/). NEW: as of version 1.0.0 the signing-service works with both version 1 and version 2 Verifiable Credentials.

Implements four http endpoints:

Expand Down Expand Up @@ -69,7 +69,7 @@ You can try this signing-service in about three minutes:
2. From a terminal prompt, run:

```
docker run -dp 4006:4006 digitalcredentials/signing-service:0.3.0
docker run -dp 4006:4006 digitalcredentials/signing-service:1.0.0
```

You can now issue test credentials as explained in the [Sign a Credential](#sign-a-credential) section.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "signing-service",
"version": "0.0.0",
"version": "1.0.0",
"type": "module",
"scripts": {
"start": "node -r dotenv/config server.js",
Expand Down

0 comments on commit 300b8e8

Please sign in to comment.