From 587b9ac114da2c12238479dc1f825810958fad07 Mon Sep 17 00:00:00 2001 From: Denis Lehmann Date: Sat, 15 Jan 2022 11:07:06 +0100 Subject: [PATCH] update README --- README.org | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.org b/README.org index f0b080b..eda40b2 100644 --- a/README.org +++ b/README.org @@ -82,13 +82,21 @@ *** 2. Include /sf/ - Grab the =sf= file from the repo, place it next to your script and source it with + There are three methods of including /sf/: - #+begin_src sh - source "$(dirname $0)/sf" - #+end_src + 1. Grab the /sf/ file from this repo, place it next to your script and source it: + #+begin_src sh + source "$(dirname $0)/sf" + #+end_src - *Or* just copy and paste the oneliner from above. + 2. Copy and paste the *oneliner* from the top of this README + + 3. Source /sf/ from the web with =curl=: + #+begin_src sh + source <(curl -s https://raw.githubusercontent.com/Deleh/sf/master/sf) + #+end_src + *Note* that this adds an online dependency to your script and if /sf/ changes your script may break. + This method should only be used for testing purposes. *** 3. Write your script