]> git.rocketbowman.com Git - proto.git/commitdiff
deprecate project main
authorKyle Bowman <kyle+github@rocketbowman.com>
Sat, 29 Nov 2025 15:54:07 +0000 (10:54 -0500)
committerKyle Bowman <kyle+github@rocketbowman.com>
Sat, 29 Nov 2025 15:54:07 +0000 (10:54 -0500)
README.md

index c0b9ece80623bc7ff040660b84d6f9111d21ac09..cdb2e1c656bb726a8a24331472ee5cb3a9f27f4b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,6 +7,12 @@
 The `proto` library simplifies the creation of command line applications by 
 inferring parser options from type signatures from functions.
 
 The `proto` library simplifies the creation of command line applications by 
 inferring parser options from type signatures from functions.
 
+Update: This project is deprecated. There is a library that is becoming more
+well-known that implements the core idea of this library: use type-annotations
+to build a command line. The library is called `typer`.
+
+https://github.com/fastapi/typer
+
 ## Design Philosophy
 
 The governing design belief is that a CLI app writer should focus on writing 
 ## Design Philosophy
 
 The governing design belief is that a CLI app writer should focus on writing 
@@ -252,4 +258,4 @@ Currently, there is no argument-specific help for a parser created by inference.
 @command(aliases=['alias1', 'alias2'], help="help message")
 def function(arg1: type1 = default1, arg2: type2 = default 2, ...)
     definition
 @command(aliases=['alias1', 'alias2'], help="help message")
 def function(arg1: type1 = default1, arg2: type2 = default 2, ...)
     definition
-```
\ No newline at end of file
+```