From acfca6ddac94d305a4e6ec55b048764887a2e1a1 Mon Sep 17 00:00:00 2001 From: Jack Wills <32690432+mrjackwills@users.noreply.github.com> Date: Mon, 19 Sep 2022 21:58:51 +0000 Subject: [PATCH] chore: Readme layout & typos --- README.md | 22 +++++++++------------- containerised/DOCKERHUB_README.md | 8 +++----- 2 files changed, 12 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index f5f5740..cb92d79 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,9 @@

-

- -

oxker

+
A simple tui to view & control docker containers

-

- A simple tui to view & control docker containers

@@ -22,7 +18,7 @@ ## Run via Docker -Published on Docker Hub, with images built for `linux/amd64`, `linux/arm64v8`, and `linux/armv6` +Published on Docker Hub, with images built for `linux/amd64`, `linux/arm64`, and `linux/arm/v6` `docker run --rm -it --volume /var/run/docker.sock:/var/run/docker.sock:ro --pull=always mrjackwills/oxker` @@ -51,12 +47,12 @@ rm oxker_linux_x86_64.tar.gz oxker In application controls | button| result| |--|--| -| ```( tab )``` or ```( shift+tab )``` | Change panel, clicking on a panel also changes the selected panel| -| ```( ↑ ↓ )``` or ```( j k )``` or ```(PgUp PgDown)``` or ```(Home End)```| Change selected line in selected panel, mouse scroll also changes selected line | +| ```( tab )``` or ```( shift+tab )``` | change panel, clicking on a panel also changes the selected panel| +| ```( ↑ ↓ )``` or ```( j k )``` or ```(PgUp PgDown)``` or ```(Home End)```| change selected line in selected panel, mouse scroll also changes selected line | | ```( enter )```| execute selected docker command| | ```( 1-9 )``` | sort containers by heading, clicking on headings also sorts the selected column | | ```( 0 )``` | stop sorting | -| ```( h )``` | Show help menu | +| ```( h )``` | toggle help menu | | ```( m )``` | toggle mouse capture - if disabled, text on screen can be selected| | ```( q )``` | to quit at any time | @@ -65,10 +61,10 @@ Available command line arguments | argument|result| |--|--| |```-d [number > 0]```| set the minimum update interval for docker information, in ms, defaults to 1000 (1 second) | -|```-r```| Show raw logs, by default oxker will remove ANSI formatting (conflicts with -c) | -|```-c```| Attempt to color the logs (conflicts with -r) | -|```-t```| Remove timestamps from each log entry | -|```-g```| No tui, basically a pointless debugging mode, for now | +|```-r```| show raw logs, by default oxker will remove ANSI formatting (conflicts with -c) | +|```-c```| attempt to color the logs (conflicts with -r) | +|```-t```| remove timestamps from each log entry | +|```-g```| no tui, basically a pointless debugging mode, for now | ## Build step diff --git a/containerised/DOCKERHUB_README.md b/containerised/DOCKERHUB_README.md index 729e79a..4339e01 100644 --- a/containerised/DOCKERHUB_README.md +++ b/containerised/DOCKERHUB_README.md @@ -1,8 +1,6 @@ -

- -

+

oxker

A simple tui to view & control docker containers @@ -17,10 +15,10 @@ ## Run -Images built for `linux/amd64`, `linux/arm64v8`, and `linux/armv6` +Images built for `linux/amd64`, `linux/arm64`, and `linux/arm/v6` `docker run --rm -it --volume /var/run/docker.sock:/var/run/docker.sock:ro --pull=always mrjackwills/oxker` ## Help -visit the Github repo \ No newline at end of file +visit the Github repo \ No newline at end of file