From 3fd3b60c43d7bc1acd866ab38685e82001a153d6 Mon Sep 17 00:00:00 2001 From: Fabrice POIRIER Date: Fri, 17 May 2019 17:33:59 +0200 Subject: [PATCH] add a short README --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 55059c7..979c010 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,15 @@ ## Overview This is a custom actionlib client-server implementation. -It can be used as one can do with the SimpleActionLib. However, it can handle multiple client for the same server, as many goal at any frequency from the same client (multi-threaded requests) without missing tracks of any goal. This means the preemptive state is useless here, as you can choose to handle the goal one after the other, or all at the same time. +It can be used in a similar way one can do with the SimpleActionLib. However, it can handle multiple client for the same server, as many goals at any frequency from the same client (multi-threaded requests) without missing tracks of any goal, and gather them in the right order. This means the preemptive state is useless here, as you can choose to handle the goals one after the other, or all at the same time. + +## Installation +In a terminal: +```shell +sudo apt install ros-kinetic-actionlib-enhanced +``` ## Examples -Examples of how this package can be used are in the directory examples. +Examples of how this package can be used are in the `examples` directory. The server can handle multiple clients without any issue. -## Installation -`pip install actionlib_enhanced` should work for most users.