From 24f49af4729c9f5e29b0cd27f94803018f12beea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alfonso=20Montero=20L=C3=B3pez?= Date: Tue, 9 Jan 2024 01:17:28 +0100 Subject: [PATCH] Readme: formatting improvements --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index e2ad8fb..ff715cc 100644 --- a/README.md +++ b/README.md @@ -60,9 +60,9 @@ Download the latest release here: https://github.com/jonhadfield/sn-cli/releases ### macOS and Linux Install: -`` +``` console $ install /usr/local/bin/sn -`` +``` ### Windows @@ -72,16 +72,16 @@ Download the binary 'sncli_windows_amd64.exe' and rename to sn.exe ## running To see commands and options: -`` +``` console $ sn --help -`` +``` ### authentication By default, your credentials will be requested every time, but you can store them using either environment variables or, on MacOS and Linux, store your session using the native Keychain application. #### environment variables Note: if using 2FA, the token value will be requested each time -``` +``` shell export SN_EMAIL= export SN_PASSWORD= export SN_SERVER= # optional, if running personal server @@ -115,26 +115,26 @@ To use your session automatically, set the environment variable ```SN_USE_SESSIO the bash completion tool should be installed by default on most Linux installations. To install on macOS (Homebrew) -`` +``` console $ brew install bash_completion -`` +``` then add the following to ~/.bash_profile: -`` +``` bash [ -f /usr/local/etc/bash_completion ] && . /usr/local/etc/bash_completion -`` +``` #### installing completion script ([found here](https://github.com/jonhadfield/sn-cli/tree/master/autocomplete/bash_autocomplete)) ##### macOS -``` +``` console $ cp bash_autocomplete /usr/local/etc/bash_completion.d/sn $ echo "source /usr/local/etc/bash_completion.d/sn" | tee -a ~/.bashrc ``` ##### Linux -`` +``` console $ cp bash_autocomplete /etc/bash_completion.d/sn $ echo "source /etc/bash_completion.d/sn" | tee -a ~/.bashrc -`` +``` ##### autocomplete commands -`` +``` console $ sn -`` +```