Skip to content

Commit b6fe6cb

Browse files
committed
Readme fix
1 parent d1423e0 commit b6fe6cb

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,23 @@ Commander-API is an easy-to-use command parser library designed for microcontrol
66

77
# 🔄 What’s New?
88

9-
### 🏗 Argument Handling
9+
### </> Argument Handling
1010
We’re really proud of this feature! Now you can easily and efficiently add arguments to your commands. The argument parser extracts the parameters you need from the raw argument string and even **automatically parses them into strings, floats, and integers** for convenience.
1111

1212
### 🌍 Environment Variables
13-
Access and modify C++ variables directly! This makes it much easier to tweak system parameters at runtime. Hopefully, tuning your **PID controller** just got a whole lot easier. 😉
13+
Access and modify variables from the command parser in the C++ domain directly! This makes it much easier to tweak system parameters at runtime. Hopefully, tuning your **PID controller** just got a whole lot easier. 😉
1414

1515
### 🔧 Major Refactoring
1616
We know "refactoring" isn’t the most exciting word—especially when it affects backward compatibility—but we believe in improving the project. We put a **huge amount of effort** into optimizing the internal structure (including a new **template-based database**—more on that later) to make Commander-API **faster, cleaner, and more scalable**.
1717

1818
### 📂 Database Overhaul
19-
This was one of our biggest tasks! The command storage system, previously tied to Commander, has been modularized for **broader use cases** (like environment variables). We also removed **recursion** entirely—even during initialization—so **embedded developers can breathe a sigh of relief**.
19+
This was one of our biggest tasks! The command storage system, previously tied to Commander class, has been modularized for **broader use cases** (like environment variables). We also removed **recursion** entirely—even during initialization—so **embedded developers can breathe a sigh of relief**.
2020

2121
### ⌨️ Auto-Complete (Experimental)
2222
We’re working on it! Early results are promising, but for now, **we don’t recommend using it yet**. Stay tuned!
2323

2424
### 🔌 Abstraction Layers
25-
As the project grew, we realized it was time to **increase abstraction** for better integration into complex systems. That’s why we introduced the **CommandCaller interface**, making it easier to integrate Commander-API into larger projects.
25+
As the project grew, we realized it was time to **increase abstraction** for better integration into complex systems. For example, that’s why we introduced the **CommandCaller interface**, making it easier to integrate Commander-API into larger projects.
2626

2727
### 📡 Pipe Module (Almost Ready!)
2828
We’re finalizing a **refactored version** of the Pipe module, which should be **more stable, easier to configure, and more flexible** than before. We just need a bit more time to document it—stay tuned for updates!
@@ -35,7 +35,7 @@ We had to say goodbye to built-in system commands. 😢 The reason? It was nearl
3535

3636
# 📚 Documentation
3737

38-
Commander-API has its own [technical documentation](https://www.commanderapi.org/html/index.html), but **most of the examples are found in the Shellminator documentation**. The Commander-specific docs are for those who want to **dive deep** into how it works under the hood. If you’re impatient, you might even find some **spoilers** about upcoming features!
38+
Commander-API has its own [technical documentation](https://www.commanderapi.org/html/index.html), but [most of the examples are found in the Shellminator documentation](https://www.shellminator.org/html/index.html). The Commander-specific docs are for those who want to **dive deep** into how it works under the hood. If you’re impatient, you might even find some **spoilers** about upcoming features!
3939

4040
# 🤝 Feedback and Contributions
4141

@@ -55,6 +55,13 @@ Every contribution, big or small, helps us grow!
5555
If this project has been helpful to you and you’d like to **buy us a coffee**, we’d really appreciate it! ☕ Every little bit helps keep this small team motivated.
5656
[![Support](extras/Assets/DocuImages/support.png)](https://ko-fi.com/danielhajnal)
5757

58+
# 🌐 Useful Links
59+
60+
- [Discussions](https://github.com/dani007200964/Commander-API/discussions) – Join the conversation and share your ideas!
61+
- [Technical Documentation](https://www.commanderapi.org/html/index.html) – Deep dive into Commander-API.
62+
- [Shellminator](https://www.shellminator.org/html/index.html) – Companion project with additional resources.
63+
- [Discord](https://discord.gg/GhMGqhBS) – Part of the Shellminator Discord server. Come chat with us!
64+
5865
# 🗨️ Contact
5966

6067
Have a question? Need help? Just want to say hi?

0 commit comments

Comments
 (0)