From 1a37be2f812d721812d86e0a8fa28c11f28a6d6e Mon Sep 17 00:00:00 2001 From: Lucas Garron Date: Mon, 4 Oct 2021 12:23:19 -0700 Subject: [PATCH] Update some `README` paths. --- README.md | 6 ++++++ certstore/README.md | 7 ++----- fakeca/README.md | 4 ++-- ietf-cms/README.md | 5 +---- ietf-cms/protocol/README.md | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 619c5b1..3052389 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,12 @@ Smimesign is an S/MIME signing utility for macOS and Windows that is compatible This project is pre-1.0, meaning that APIs and functionality may change without warning. +This package also contains reusable libraries in nested packages: + +- [`github.com/smimesign/certstore`](./certstore) +- [`github.com/smimesign/fakeca`](./fakeca) +- [`github.com/smimesign/ietf-cms`](./ietf-cms) + ## Contributing Different organizations do PKI differently and we weren't able to test everyone's setup. Contributions making this tool work better for your organization are welcome. See the [contributing docs](CONTRIBUTING.md) for more information on how to get involved. diff --git a/certstore/README.md b/certstore/README.md index e68de37..d8fc2f3 100644 --- a/certstore/README.md +++ b/certstore/README.md @@ -1,7 +1,4 @@ -# certstore [![PkgGoDev](https://pkg.go.dev/badge/github.com/github/certstore?tab=doc)](https://pkg.go.dev/github.com/github/certstore?tab=doc) [![Report card](https://goreportcard.com/badge/github.com/github/certstore)](https://goreportcard.com/report/github.com/github/certstore) - -[![Test macOS (recent Go versions)]()](https://github.com/github/certstore/actions?query=workflow%3A%22Test+macOS+%28recent+Go+versions%29%22) -[![Test Windows (recent Go versions)]()](https://github.com/github/certstore/actions?query=workflow%3A%22Test+Windows+%28recent+Go+versions%29%22) +# certstore [![PkgGoDev](https://pkg.go.dev/badge/github.com/github/smimesign/certstore?tab=doc)](https://pkg.go.dev/github.com/github/smimesign/certstore?tab=doc) Certstore is a Go library for accessing user identities stored in platform certificate stores. On Windows and macOS, certstore can enumerate user identities and sign messages with their private keys. @@ -19,7 +16,7 @@ import ( "crypto/rand" "crypto/sha256" - "github.com/github/certstore" + "github.com/github/smimesign/certstore" ) func main() { diff --git a/fakeca/README.md b/fakeca/README.md index 9fbe407..6a7db21 100644 --- a/fakeca/README.md +++ b/fakeca/README.md @@ -1,4 +1,4 @@ -# fakeca [![PkgGoDev](https://pkg.go.dev/badge/github.com/github/fakeca?tab=doc)](https://pkg.go.dev/github.com/github/fakeca?tab=doc) [![Report card](https://goreportcard.com/badge/github.com/github/fakeca)](https://goreportcard.com/report/github.com/github/fakeca) [![Actions CI](https://github.com/github/fakeca/workflows/Test/badge.svg)](https://github.com/github/fakeca/actions?query=workflow%3ATest) +# fakeca [![PkgGoDev](https://pkg.go.dev/badge/github.com/github/smimesign/fakeca?tab=doc)](https://pkg.go.dev/github.com/github/smimesign/fakeca?tab=doc) This is a package for creating fake certificate authorities for test fixtures. @@ -10,7 +10,7 @@ package main import ( "crypto/x509/pkix" - "github.com/github/fakeca" + "github.com/github/smimesign/fakeca" ) func main() { diff --git a/ietf-cms/README.md b/ietf-cms/README.md index 0d7aef7..b026503 100644 --- a/ietf-cms/README.md +++ b/ietf-cms/README.md @@ -1,7 +1,4 @@ -# CMS [![PkgGoDev](https://pkg.go.dev/badge/github.com/github/ietf-cms?tab=doc)](https://pkg.go.dev/github.com/github/ietf-cms?tab=doc) [![Report card](https://goreportcard.com/badge/github.com/github/ietf-cms)](https://goreportcard.com/report/github.com/github/ietf-cms) - -[![Test (recent Go versions)]()](https://github.com/github/ietf-cms/actions?query=workflow%3A%22Test+%28recent+Go+versions%29%22) -[![Test (Go 1.10)]()](https://github.com/github/ietf-cms/actions?query=workflow%3A%22Test+%28Go+1.10%29%22) +# CMS [![PkgGoDev](https://pkg.go.dev/badge/github.com/github/smimesign/ietf-cms?tab=doc)](https://pkg.go.dev/github.com/github/smimesign/ietf-cms?tab=doc) [CMS (Cryptographic Message Syntax)](https://tools.ietf.org/html/rfc5652) is a syntax for signing, digesting, and encrypting arbitrary messages. It evolved from PKCS#7 and is the basis for higher level protocols such as S/MIME. This package implements the SignedData CMS content-type, allowing users to digitally sign data as well as verify data signed by others. diff --git a/ietf-cms/protocol/README.md b/ietf-cms/protocol/README.md index 05512cf..5a81475 100644 --- a/ietf-cms/protocol/README.md +++ b/ietf-cms/protocol/README.md @@ -1,4 +1,4 @@ -# cms/protocol [![GoDoc](https://godoc.org/github.com/github/ietf-cms/protocol?status.svg)](https://godoc.org/github.com/github/ietf-cms/protocol) +# cms/protocol [![GoDoc](https://pkg.go.dev/badge/github.com/github/smimesign/ietf-cms/protocol?utm_source=godoc)](https://pkg.go.dev/github.com/github/smimesign/ietf-cms?tab=doc) cms/protocol implements low-level parsing of CMS (PKCS#7) data.