From 44ca5816bd03230abe29d907897aa84037962ff9 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Mon, 13 Jul 2020 13:44:52 -0600 Subject: [PATCH] clarify README's intended audience --- README.md | 49 +++++++++++++++++++++++++++---------------------- 1 file changed, 27 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index b894ee3..64be737 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # @webinstall/packages -> WebInstall is how developers install their tools +> `webi` is how developers install their tools + +- no `sudo` +- no package manager +- no messing with system permissions +- in short: no nonsense ```bash curl https://webinstall.dev/webi | bash @@ -9,30 +14,11 @@ curl https://webinstall.dev/webi | bash This repository contains the primary and community-submitted packages for [webinstall.dev](https://webinstall.dev). -# Installer Guidelines - -- Should install to `$HOME/.local/opt/-` or `$HOME/.local/bin` -- Should not need `sudo` (except perhaps for a one-time `setcap`, etc) -- Examples: - - Full Packages: - - Node.js: - - Golang: - - PostgreSQL: - - Single-Binary Installers: - - Caddy: - - Ripgrep: - - Gitea: - - Convenience Scripts: - - Prettier: - - Rust-lang: - - Rust-lang: - - -# How it works +# How `webi` works - Contacts official release APIs for download URLs - Selects the appropriate package version and archive format -- Installs to `$HOME/.local/` +- Installs to `$HOME/.local/opt` or `$HOME/.local/bin`, as appropriate. - Updates `PATH` via `$HOME/.config/envman/PATH.env` - Symlinks or copies current selected version @@ -58,6 +44,25 @@ More technically: `https://webinstall.dev/api/installers/@.sh?formats=zip,tar` - `bash install-.sh` => download, unpack, move, link, update PATH +# Philosophy (for package authors / maintainers publishing with webi) + +- Should install to `$HOME/.local/opt/-` or `$HOME/.local/bin` +- Should not need `sudo` (except perhaps for a one-time `setcap`, etc) +- Examples: + - Full Packages: + - Node.js: + - Golang: + - PostgreSQL: + - Single-Binary Installers: + - Caddy: + - Ripgrep: + - Gitea: + - Convenience Scripts: + - Prettier: + - Rust-lang: + - vim-sensible: + + ## Creating an Installer An install consists of 5 parts in 4 files: -- 2.25.1