refactor: finish moving ssh-* scripts to own installers
[webi-installers/.git] / README.md
index 64be7376e3d4c12674dec07f5b13fbcd79771401..376623e462d43529322e40c49669c03e5d839f0b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
-# @webinstall/packages
+# [webi-installers](https://github.com/webinstall/webi-installers)
 
-> `webi` is how developers install their tools
+> [webi](https://webinstall.dev) is how developers install their tools
+
+[![webinstall-dev-ogimage-github](https://user-images.githubusercontent.com/122831/129465590-136b5a8a-f8f5-4e8d-a010-784eaa9f21bb.png)](https://webinstall.dev)
 
 - no `sudo`
 - no package manager
@@ -14,7 +16,7 @@ curl https://webinstall.dev/webi | bash
 This repository contains the primary and community-submitted packages for
 [webinstall.dev](https://webinstall.dev).
 
-# How `webi` works
+# How webi works
 
 - Contacts official release APIs for download URLs
 - Selects the appropriate package version and archive format
@@ -25,7 +27,7 @@ This repository contains the primary and community-submitted packages for
 More technically:
 
 1. `<package>/releases.js` transforms the package's release API into a common
-   formatt
+   format
    - (i.e. HTML, CSV, TAB, or JSON into a specific JSON format)
    - common release APIs are in `_common/` (i.e. `_common/github.js`)
 2. `_webi/bootstrap.sh` is a template that exchanges system information for a
@@ -242,7 +244,7 @@ WEBI_SINGLE=""
 
 ```bash
 webi_check              # Checks to see if the selected version is already installed (and re-links if so)
-webi_download           # Downloads the selected release to $HOME/Downloads/<package-name>.tar.gz
+webi_download           # Downloads the selected release to $HOME/Downloads/webi/<package-name>.tar.gz
 webi_extract            # Extracts the download to /tmp/<package-name>-<random>/
 webi_path_add /new/path # Adds /new/path to PATH for bash, zsh, and fish
 webi_pre_install        # Runs webi_check, webi_download, and webi_extract