docs: add note about 1.0 to README

alecthomas · Sep 18, 2024 · 277a5f0 · 277a5f0
1 parent 3b28c2c
commit 277a5f0
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -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)
@@ -42,6 +43,12 @@
 
 <!-- /TOC -->
 
+## Version 1.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.
@@ -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.                                                                                                                                                                                                           |