Skip to content

Commit b259a87

Browse files
committed
Document Fix for V2.0.2
1 parent db0e198 commit b259a87

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

Doc/markdown_pages/main_page.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
@mainpage Commander-API library
2+
**Version V2.0.1**
3+
4+
Commander-API is a simple-to-use parser library, and you can easily use it to process character based commands and link them to a specified function. It is designed mainly to work with low memory capacity devices, for example, __small ARM or AVR processors__.
5+
6+
## Changes in V2
7+
8+
Version 2.X is a more refined version of the original Commander-API. The original was working well, but it was a bit flimsy when you had to work with a huge API list.
9+
It also caused Hard-fault when the API tree was not created correctly. Besides that, if you wanted to add a new command, you had to change the header and the source
10+
file as well. The biggest problem was, that it was a C-API, so no overloading, no C++ magic.
11+
12+
The new version is designed from ground up and the main motivation was to make it as reliable as the original, but make it much simpler to use.
13+
14+
__Key changes:__
15+
* Full C++ API
16+
* Arduino compatible without any modifications
17+
* Platform-IO compatibility( still in progress )
18+
* Simpler usage
19+
* Better example
20+
* Low memory consumption to make it compatible with lower end devices like Arduino UNO, Nano...
21+
* Response function overload. Thanks to C++ the response function can be anything like Serial, WiFiClient...
22+
23+
## Contributing
24+
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
25+
26+
Please make sure to update tests as appropriate.
27+
28+
## Donation
29+
If this project help you reduce time to develop, you can give me a cup of coffee \emoji :coffee: \emoji :coffee: \emoji :coffee:
30+
31+
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/donate?hosted_button_id=YFGZD78H6K2CS)
32+
33+
## License & copyright
34+
© Daniel Hajnal
35+
36+
\emoji :email: [email protected]
37+
38+
Licensed under the MIT License

0 commit comments

Comments
 (0)