From 454f9d2bf4b8bbfe6404a62b0fc12269e1c95d02 Mon Sep 17 00:00:00 2001 From: zoeyrinha Date: Sun, 17 Nov 2024 17:16:34 -0300 Subject: [PATCH] add roadmap to readme --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 5a529b4..6b9fba8 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,26 @@ end More different ways to use this library can be found on the [examples](./examples) folder Documentation on defining a CLI module can be found at the [Nexus.CLI](https://hexdocs.pm/nexus_cli/Nexus.CLI.html) +# Roadmap + +| Feature | Status | Description | +|----------------------------------|--------------|-----------------------------------------------------------------------------------------------| +| **Core Nexus.CLI Implementation**| βœ… Completed | Base implementation of the `Nexus.CLI` module with macro-based DSL for defining CLIs. | +| **Automatic Help Generation** | βœ… Completed | Automatically generate help messages based on command definitions. | +| **Command Parsing and Dispatching**| βœ… Completed| Parse user input and dispatch commands to the appropriate handlers. | +| **Nexus.TUI Development** | 🚧 In Progress | Build the `Nexus.TUI` module leveraging Phoenix LiveView and TEA for terminal UIs. | +| **TUI Component Library** | πŸ”œ Planned | Develop reusable components for building terminal UIs. | +| **Integration with Phoenix LiveView**| πŸ”œ Planned| Integrate `Nexus.TUI` with Phoenix LiveView for live terminal experiences. | +| **Community Contributions** | ♾️ Ongoing | Encourage and incorporate feedback and contributions from the community. | + +### Features +- Macro based DSL + - [x] define global/root commands + - [x] define subcommands (supporting nesting) + - [x] define flags + - [ ] define global/root flags +- [x] Automatic help flags generation + ## Why "Nexus" Nexus is a connection from two different worlds! This library connects the world of CLIs with the magic world of `Elixir`!