Skip to content

Commit

Permalink
Update some README paths.
Browse files Browse the repository at this point in the history
  • Loading branch information
lgarron committed Oct 4, 2021
1 parent a63c2e8 commit 1a37be2
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 2 additions & 5 deletions certstore/README.md
Original file line number Diff line number Diff line change
@@ -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/workflows/Test%20macOS%20(recent%20Go%20versions)/badge.svg>)](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/workflows/Test%20Windows%20(recent%20Go%20versions)/badge.svg>)](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.

Expand All @@ -19,7 +16,7 @@ import (
"crypto/rand"
"crypto/sha256"

"github.com/github/certstore"
"github.com/github/smimesign/certstore"
)

func main() {
Expand Down
4 changes: 2 additions & 2 deletions fakeca/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -10,7 +10,7 @@ package main
import (
"crypto/x509/pkix"

"github.com/github/fakeca"
"github.com/github/smimesign/fakeca"
)

func main() {
Expand Down
5 changes: 1 addition & 4 deletions ietf-cms/README.md
Original file line number Diff line number Diff line change
@@ -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/workflows/Test%20(recent%20Go%20versions)/badge.svg>)](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/workflows/Test%20(Go%201.10)/badge.svg>)](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.

Expand Down
2 changes: 1 addition & 1 deletion ietf-cms/protocol/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down

0 comments on commit 1a37be2

Please sign in to comment.