From 56f20698b9d99e56af965c42f3750490355c26f5 Mon Sep 17 00:00:00 2001 From: "Carpenter, Adam (CORP)" Date: Tue, 12 Oct 2021 15:48:02 -0400 Subject: docs: newer examples in readme --- README.md | 102 +++++++++++++++++++++++++++++++++----------------------------- 1 file changed, 55 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 21300aa..636a3c7 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,20 @@ [![Conventional git style](https://img.shields.io/badge/git%20style-conventional%20commit-blue)](https://conventionalcommits.org/) -Angelshark is a collection of programs that make automating over Communication -Managers (ACMs) easier. It uses the OSSI protocol over SSH to run user commands -on one or more configurable ACMs. This functionality is exposed as a developer -library (`libangelshark`), a command line application (`angelsharkcli`), and an -HTTP daemon (`angelsharkd`). +Altruistic Angelshark is a project devoted to making Communication Manager (ACM) +automation easier. It uses the OSSI protocol over SSH to run user commands on +one or more configurable ACMs. This functionality is exposed as a developer +library ([`libangelshark`](./libangelshark)), a command line application +([`angelsharkcli`](./angelsharkcli)), and an HTTP daemon +([`angelsharkd`](./angelsharkd)). ## Detailed User Guides -These guides give an overview of the end-user Angelshark programs, their +These guides give an overview of the end-user Angelshark applications, their capabilities, and common use cases. It assumes the user has familiarity with -using a shell and the command line. Some of the commands may be formatted for -\*nix, others for Windows. They should all be directly translatable, just make -sure you're using (for example) `./angelsharkcli` for \*nix and -`./angelsharkcli.exe` for Windows. +using a shell and the command line. Most commands are formatted for \*nix. They +should all be directly translatable to Windows, just make sure you're using (for +example) `angelsharkcli` for \*nix and `angelsharkcli.exe` for Windows. - [`angelsharkcli`](angelsharkcli/README.md): a command line application for running OSSI-formatted commands on one or more ACMs and parses the output data @@ -45,78 +45,86 @@ cargo install --git https://github.com/adpllc/altruistic-angelshark.git angelsha Get the numbers and names of all stations on a single ACM via the CLI. ```sh -$ printf 'aCM01\nclist stat\nf8005ff00\nf8003ff00\nt\n' | angelsharkcli print -17571230001 Doe, Jane -17571230002 Doe, John -17571230003 Conference Rm. 1 +$ printf 'a03\nclist stat\nf8005ff00\nf8003ff00\nt\n' | angelsharkcli print +17571230001 Arnold, Ray +17571230002 Muldoon, Robert +17571230003 Panic Rm. 1 ``` Check three ACMs for a station and print it as JSON via the CLI. ```sh -$ angelsharkcli print <