Skip to content

Commit

Permalink
docs: add note about 1.0 to README
Browse files Browse the repository at this point in the history
  • Loading branch information
alecthomas committed Sep 18, 2024
1 parent 3b28c2c commit 31301f5
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

<!-- TOC depthfrom:2 depthto:3 -->

- [Release](#release)
- [Introduction](#introduction)
- [Help](#help)
- [Help as a user of a Kong application](#help-as-a-user-of-a-kong-application)
Expand Down Expand Up @@ -42,6 +43,12 @@

<!-- /TOC -->

## Version 1.0.0 Release

Kong has been stable for a long time, so it seemed appropriate to cut a 1.0 release.

There is one breaking change, #436, which should effect relatively few users.

## Introduction

Kong aims to support arbitrarily complex command-line structures with as little developer effort as possible.
Expand Down Expand Up @@ -554,7 +561,7 @@ Tags can be in two forms:
Both can coexist with standard Tag parsing.

| Tag | Description |
|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `cmd:""` | If present, struct is a command. |
| `arg:""` | If present, field is an argument. Required by default. |
| `env:"X,Y,..."` | Specify envars to use for default value. The envs are resolved in the declared order. The first value found is used. |
Expand Down

0 comments on commit 31301f5

Please sign in to comment.