Skip to content

Commit

Permalink
add roadmap to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zoedsoupe authored Nov 17, 2024
1 parent 78a83fd commit 454f9d2
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`!
Expand Down

0 comments on commit 454f9d2

Please sign in to comment.