From: AJ ONeal <coolaj86@gmail.com>
Date: Mon, 13 Jul 2020 19:44:52 +0000 (-0600)
Subject: clarify README's intended audience
X-Git-Url: https://git.josue.xyz/?a=commitdiff_plain;h=44ca5816bd03230abe29d907897aa84037962ff9;p=webi-installers%2F.git

clarify README's intended audience
---

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/<package>-<version>` or `$HOME/.local/bin`
-- Should not need `sudo` (except perhaps for a one-time `setcap`, etc)
-- Examples:
-  - Full Packages:
-    - Node.js: <https://github.com/webinstall/packages/tree/master/node>
-    - Golang: <https://github.com/webinstall/packages/tree/master/golang>
-    - PostgreSQL: <https://github.com/webinstall/packages/tree/master/postgres>
-  - Single-Binary Installers:
-    - Caddy: <https://github.com/webinstall/packages/tree/master/caddy>
-    - Ripgrep: <https://github.com/webinstall/packages/tree/master/ripgrep>
-    - Gitea: <https://github.com/webinstall/packages/tree/master/gitea>
-  - Convenience Scripts:
-    - Prettier: <https://github.com/webinstall/packages/tree/master/prettier>
-    - Rust-lang: <https://github.com/webinstall/packages/tree/master/rustlang>
-    - Rust-lang:
-      <https://github.com/webinstall/packages/tree/master/vim-sensible>
-
-# 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/<pkg>@<ver>.sh?formats=zip,tar`
    - `bash install-<pkg>.sh` => download, unpack, move, link, update PATH
 
+# Philosophy (for package authors / maintainers publishing with webi)
+
+- Should install to `$HOME/.local/opt/<package>-<version>` or `$HOME/.local/bin`
+- Should not need `sudo` (except perhaps for a one-time `setcap`, etc)
+- Examples:
+  - Full Packages:
+    - Node.js: <https://github.com/webinstall/packages/tree/master/node>
+    - Golang: <https://github.com/webinstall/packages/tree/master/golang>
+    - PostgreSQL: <https://github.com/webinstall/packages/tree/master/postgres>
+  - Single-Binary Installers:
+    - Caddy: <https://github.com/webinstall/packages/tree/master/caddy>
+    - Ripgrep: <https://github.com/webinstall/packages/tree/master/ripgrep>
+    - Gitea: <https://github.com/webinstall/packages/tree/master/gitea>
+  - Convenience Scripts:
+    - Prettier: <https://github.com/webinstall/packages/tree/master/prettier>
+    - Rust-lang: <https://github.com/webinstall/packages/tree/master/rustlang>
+    - vim-sensible:
+      <https://github.com/webinstall/packages/tree/master/vim-sensible>
+
 ## Creating an Installer
 
 An install consists of 5 parts in 4 files: