docs(README): Add simple README to project

This commit is contained in:
Vincent Ambo 2018-03-19 14:10:48 +01:00
parent ade52d2423
commit df29b08bff

31
README.md Normal file
View file

@ -0,0 +1,31 @@
mq-cli
======
This project provides a very simple CLI interface to [POSIX message queues][].
It can be used to create and inspect queues, as well as send and
receive messages from them.
```
1.0.0
Administrate and inspect POSIX message queues
USAGE:
mq <SUBCOMMAND>
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
SUBCOMMANDS:
create Create a new queue
help Prints this message or the help of the given subcommand(s)
inspect inspect details about a queue
ls list message queues
receive Receive a message from a queue
rlimit Get the message queue rlimit
send Send a message to a queue
```
[POSIX message queues]: https://linux.die.net/man/7/mq_overview