qrlkit 0.7.0 → 0.9.2

package/README.md

@@ -21,7 +21,7 @@ rs = "https://github.com/qrlkit/qrlkit-rs"
 web = "https://github.com/qrlkit/qrlkit-web"
 
 [repos.prs]
-rs = "https://github.com/qrlkit/qrlkit-rs"
+rs = "https://github.com/qrlkit/qrlkit-rs/pulls"
 web = "https://github.com/qrlkit/qrlkit-web/pulls"
 
 [qk.check]
@@ -77,23 +77,37 @@ and 2) have as little friction as possible:
 
 ## Install
 
-*Step 1* Clone repo and install qrlkit binary 
+### From package manager  
+
+A few package managers can be used to install the binary for your platform:
 
 ```
-git clone git@github.com:qrlkit/qrlkit-rs.git
-cd qrlkit-rs
-cargo install --path .
+cargo install qrlkit
+
+npm i -g qrlkit
+
+bun add -g qrlkit
+
+yarn global add qrlkit
 
-# Then start init to set the defaults you want (shell, browser etc)
-qrlkit init 
 ```
 
-*Step 2* Write some config you want 
+### From Github release:
 
-*Step 3* Add the config
+Install the latest release for Linux or macOS into `~/.local/bin`:
+
+```sh
+curl -fsSL https://raw.githubusercontent.com/qrlkit/qrlkit-rs/main/install.sh | sh
+```
+
+### From Source  
+
+Clone repo and install qrlkit binary with cargo  
 
 ```
-qrlkit add shortcuts.toml
+git clone git@github.com:qrlkit/qrlkit-rs.git
+cd qrlkit-rs
+cargo install --path .
 ```
 
 ## Version 1 Roadmap
@@ -131,9 +145,9 @@ Current version is 0.5.5 but any minor version can ship with a breaking change u
 - [x] dir hooks
 - [x] browser hooks
 - [x] run shell scripts
-- [ ] automatic docs
-- [ ] hardcoded arg suggestions
-- [ ] constants 
+- [x] automatic hints
+- [x] hardcoded arg suggestions
+- [x] constants 
 
 #### package managers ####
 
@@ -221,20 +235,57 @@ dirhook = "cd $dir && tree -L 1"
 project = "~/dev/{repo}"
 ```
 
+**constants**
+
+Define reusable strings or lists in `[constants]`. Use `{constants.name}` in paths and URLs. For shared values, put `[constants]` in `constants.toml` beside the state file and use `{global.name}`.
+
+```toml
+[constants]
+root = "~/dev"
+namespaces = ["dev", "staging", "prod"]
+
+[projects]
+api = "{constants.root}/api"
+```
+
 **scripts**
 
 Scripts run in Bash by default from the config's directory.
 Reserved key `shell` overrides it with options `bash`, `sh`, and `zsh`.
-Use `$` notation to pass arguments.
+Use `$` notation to pass arguments. Use args to prompt users for inputs.
 
 ```toml
 [kube.logs]
+args = [
+  { name = "namespace", enum = { ref = "constants.namespaces" } },
+  { name = "pod" },
+]
 run = '''
 kubectl logs --namespace "$1" "$2" --follow
 '''
 shell = "zsh"
 ```
 
+**hints**
+
+Comments with `hint: ` in them will be included in the terminal.
+
+```toml
+[launch]
+# hint: Find your next mission
+issues = "https://github.com/ratatui/ratatui/issues"
+
+repo = "https://github.com/ratatui/ratatui" # hint: Browse the source code
+```
+
+Run `qrlkit launch` after importing the config:
+
+```text
+> issues        Find your next mission
+  repo          Browse the source code
+```
+
+
 ## Contributing
 
 Contributions are welcome! 

package/package.json

@@ -9,10 +9,10 @@
     "README.md"
   ],
   "optionalDependencies": {
-    "qrlkit-darwin-arm64": "0.7.0",
-    "qrlkit-darwin-x64": "0.7.0",
-    "qrlkit-linux-arm64": "0.7.0",
-    "qrlkit-linux-x64": "0.7.0"
+    "qrlkit-darwin-arm64": "0.9.2",
+    "qrlkit-darwin-x64": "0.9.2",
+    "qrlkit-linux-arm64": "0.9.2",
+    "qrlkit-linux-x64": "0.9.2"
   },
   "os": [
     "linux",
@@ -34,5 +34,5 @@
   "bugs": {
     "url": "https://github.com/qrlkit/qrlkit-rs/issues"
   },
-  "version": "0.7.0"
+  "version": "0.9.2"
 }