From d9ae721d245c58ad4f2130b8e315c43593bc9e91 Mon Sep 17 00:00:00 2001 From: Ravi Patel <82118011+rpatel-figure@users.noreply.github.com> Date: Mon, 12 Feb 2024 11:58:02 -0600 Subject: [PATCH] chore: Make README more useful, add self as developer of artifact (#13) --- .github/CODEOWNERS | 1 + README.md | 26 +++++++++++++++++++++++++- build.gradle.kts | 5 +++++ 3 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 .github/CODEOWNERS diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..06af846 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @cworsnop-figure @rpatel-figure diff --git a/README.md b/README.md index 961dc4d..d8ea3a3 100644 --- a/README.md +++ b/README.md @@ -2,5 +2,29 @@ Generic approach to fetching access-controlled keys for Provenance. +## Status + +[![stability-release-candidate](https://img.shields.io/badge/stability-pre--release-48c9b0.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#release-candidate) +[![Latest Release][release-badge]][release-latest] +[![Artifact][publication-badge]][publication-url] + +[release-badge]: https://img.shields.io/github/v/tag/provenance-io/kms-connector.svg +[release-latest]: https://github.com/provenance-io/kms-connector/releases/latest +[publication-badge]: https://maven-badges.herokuapp.com/maven-central/io.provenance.kms-connector/lib/badge.svg +[publication-url]: https://maven-badges.herokuapp.com/maven-central/io.provenance.kms-connector/lib/ +[loc-badge]: https://tokei.rs/b1/github/provenance-io/kms-connector +[loc-report]: https://github.com/provenance-io/kms-connector + ## Prerequisites -## Examples \ No newline at end of file + +## Examples +### Vault +#### JSON Key Entry +```json +{ + "public_signing_key": "0A21024D346A99201D31FCA89A7B8FD1F5AEC3B13E5A4B08FFE6A7C2174C7CC6C0B90D2001", + "private_signing_key": "0A20C637707D9E94E30EB10ED4CF914C1D9C863B17AFA68B97A1F6EDEF5E220AEB92", + "public_encryption_key": "0A210260CF86C34A828D0F147A707A4EF9CF3507FE03F456404051A7A65EE9CA62E2A82001", + "private_encryption_key": "0A207BBEEB9EEEEDF05AB12495EE93FD5C5CA29CD49FA99E347C7D2AFC957F83D9AA" +} +``` diff --git a/build.gradle.kts b/build.gradle.kts index 3c006c1..673d29f 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -73,6 +73,11 @@ subprojects { name.set("Cody Worsnop") email.set("cworsnop@figure.com") } + developer { + id.set("rpatel-figure") + name.set("Ravi Patel") + email.set("rpatel@figure.com") + } } scm {