add packages prefix

[webi-installers/.git] / README.md

diff --git a/README.md b/README.md
index 1b6122599f76de375aed7f7030d84542550cabae..fce261fd8ef0f046fa17c351440fe7332a96ea9d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,29 @@
 # packages
-the community-submitted packages for webinstall.dev
+
+Primary and community-submitted packages for
+[webinstall.dev](https://webinstall.dev)
+
+# Guidelines
+
+- Should install to `./local/opt/<package>-<version>`
+- Should not need `sudo` (except perhaps for a one-time `setcap`, etc)
+- Follow the example of
+  <https://github.com/webinstall/packages/tree/master/node>
+
+  - Note: the version handling is nasty, we'd like to move this to an API
+
+# Roadmap
+
+- Wrap release APIs to unify and expose
+  - [ ] Golang <https://golang.org/dl/?mode=json>
+  - [ ] Node <https://nodejs.org/dist/index.tab>
+  - [ ] Flutter
+        <https://storage.googleapis.com/flutter_infra/releases/releases_linux.json> -
+        Started at
+        <https://github.com/webinstall/packages/blob/master/flutter/versions.js>
+  - [ ] git
+    - Note: do all platforms expose tar/zip releases with the same URLs?
+  - [ ] npm
+  - [ ] github (NOT until `git` is supported)
+- [ ] Support git urls (i.e. `@github.com/node/node`)
+  - (maybe `ghi node/node` for github specifically)