Skip to content

Commit

Permalink
doc: add install-free go run and table of contents (#70)
Browse files Browse the repository at this point in the history
  • Loading branch information
tsaarni authored Oct 26, 2024
1 parent 34c8dc5 commit cf3b6be
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ No more storing test certificates and private keys in the repository!
![](https://github.com/tsaarni/certyaml/workflows/unit-tests/badge.svg)
[![Go Reference](https://pkg.go.dev/badge/github.com/tsaarni/certyaml.svg)](https://pkg.go.dev/github.com/tsaarni/certyaml)

## Table of Contents

- [Description](#description)
- [Using certyaml](#using-certyaml)
- [Installing](#installing)
- [YAML Syntax](#yaml-syntax)
- [Go API](#go-api)

## Description

Certyaml is a command line tool and a Go API for issuing certificates.
Expand Down Expand Up @@ -50,6 +58,13 @@ go install github.com/tsaarni/certyaml/cmd/certyaml@latest

The executable will be stored in the go path, by default `~/go/bin/certyaml`.

Alternatively, you can run the tool without installing it:

```bash
go run github.com/tsaarni/certyaml/cmd/certyaml@latest
```


### Using certyaml

Create a YAML manifest file which describes the wanted PKI hierarchy and end-entity certificates
Expand Down

0 comments on commit cf3b6be

Please sign in to comment.