diff options
author | Vincent Ambo <tazjin@gmail.com> | 2018-03-19T13·10+0100 |
---|---|---|
committer | Vincent Ambo <tazjin@gmail.com> | 2018-03-19T13·10+0100 |
commit | df29b08bffc90cfd4f2d963a8e48d89f7a86308d (patch) | |
tree | 50b38194b51381c4ca1628bcea3dc2c263b1918c /README.md | |
parent | ade52d2423a4f9f8e0190b4e438823cbbc910c75 (diff) |
docs(README): Add simple README to project
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 000000000000..e612553e7447 --- /dev/null +++ b/README.md @@ -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 |