add examples
authorAJ ONeal <aj@therootcompany.com>
Tue, 28 Apr 2020 00:11:18 +0000 (00:11 +0000)
committerAJ ONeal <aj@therootcompany.com>
Tue, 28 Apr 2020 00:11:18 +0000 (00:11 +0000)
brew/brew.bash
flutter/flutter.bash
golang/golang.bash
node/node.bash
pathman/pathman.bash
rustlang/rustlang.bash
serviceman/serviceman.bash
vim-sensible/vim-sensible.bash
webi/webi.bash

index 2cdd6d78138c6d5ecc6d9d48384c33283394748f..e95a5726a89f0b3bda548da5a39d482556e1b296 100644 (file)
@@ -5,6 +5,10 @@
 # tagline: The Missing Package Manager for macOS (or Linux)
 # description: |
 #   Homebrew installs the stuff you need that Apple (or your Linux system) didn’t.
+# examples: |
+#   ```bash
+#   brew install node
+#   ```
 
 # Straight from https://brew.sh
 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
index 6fe96881a93b346d4073fb87df4b648b0458a180..548ef72ae0247feb79487d0526591df3b43d326c 100644 (file)
@@ -5,6 +5,10 @@
 # tagline: UI Toolkit for mobile, web, and desktop
 # description: |
 #   Flutter is Google’s UI toolkit for building beautiful, natively compiled applications for mobile, web, and desktop from a single codebase.
+# examples: |
+#   ```bash
+#   flutter create my_app
+#   ```
 
 set -e
 set -u
index e61de1408bfa91c9f4b9a68638f23d191b4e4758..f599c761466fa91449e51f42adda2ec3ef87f9d7 100644 (file)
@@ -5,6 +5,34 @@
 # tagline: The Go Programming Language tools
 # description: |
 #   Go is an open source programming language that makes it easy to build simple, reliable, and efficient software.
+# examples: |
+#   ```bash
+#   mkdir -p hello/
+#   pushd hello/
+#   ```
+#   <br/>   
+#
+#   ```bash
+#   cat << EOF >> main.go
+#   package main
+#   
+#   import (
+#     "fmt"
+#   )
+#   
+#   func main () {
+#     fmt.Println("Hello, World!")
+#   }
+#   EOF
+#   ```
+#   <br/>   
+#
+#   ```bash
+#   go fmt ./...
+#   go build .
+#   ./hello
+#   > Hello, World!
+#   ```
 
 set -e
 set -u
index 33a9abb7e0e9061ef32828c8c8ace1f77e48318f..cac1272bca3cb08d2ca52abc448249c0474b1526 100644 (file)
@@ -5,6 +5,48 @@
 # tagline: JavaScript V8 runtime
 # description: |
 #   Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine
+# examples: |
+#   ```bash
+#   node -e 'console.log("Hello, World!")'
+#   > Hello, World!
+#   ```
+#   <br/>
+#   <br/>
+#   
+#   <table>
+#   <tr>
+#   <td>Run a webserver</td>
+#   <td><pre><code class="language-bash">
+#   mkdir my-server
+#   pushd my-server
+#   npm init
+#   npm install --save express</code></pre>
+#   <br/>
+#   <code>app.js:</code>
+#   <br/>
+#   <pre><code class="language-javascript">'use strict'
+#   var express = require('express');
+#   var app = express();
+#   
+#   app.use('/', function (req, res, next) {
+#     res.end("Hello, World!");
+#   });
+#   
+#   module.exports = app;</code></pre>
+#   <br/>
+#   <code>server.js:</code>
+#   <br/>
+#   <pre><code class="language-javascript">'use strict'
+#   var http = require('http');
+#   var app = require('./app.js');
+#   http.createServer(app).listen(8080, function () {
+#     console.log('Listening on', this.address());
+#   });</code></pre>
+#   <br/>
+#   <pre><code class="language-bash">npm start</code></pre>
+#   </td>
+#   </tr>
+#   </table>
 
 set -e
 set -u
index 82bd622643129f01d95b3d77bb4c3f4927a9d28a..7de2693a9918b85e6d04243925189ab71fa704dc 100644 (file)
@@ -8,6 +8,19 @@
 #   - Mac, Windows, Linux
 #   - Bash, Zsh, Fish
 #   - Command, Powershell
+# examples: |
+#   ```bash
+#   pathman add ~/.local/bin
+#   ```
+#   <br/>
+#   ```bash
+#   pathman remove ~/.local/bin
+#   ```
+#   <br/>
+#   ```bash
+#   pathman list
+#   ```
+
 
 set -e
 set -u
index 392356c7e0b24b980a30303b720a6f42b5c2259e..df5a8e43a6d53e9fde93847bf3349633c7e47c98 100644 (file)
@@ -5,6 +5,18 @@
 # tagline: The Rust Toolchain
 # description: |
 #   A language empowering everyone to build reliable and efficient software.
+# examples: |
+#   ```bash
+#   cargo install ripgrep
+#   ```
+#   <br/>
+#   ```bash
+#   cargo new hello --bin
+#   cargo build --release
+#   ./hello
+#   > "Hello, world!"
+#   ```
+
 
 # Straight from https://rustup.rs/
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
index 6aa1779a3311f3007274558f8e4ef3fc8ed19302..539852134df0e47bc93a836590ecf5a90fb7f1ed 100644 (file)
@@ -8,6 +8,10 @@
 #   - Launchd (macOS)
 #   - Systemd (Linux)
 #   - Windows Registry
+# examples: |
+#   ```bash
+#   serviceman add --name my-service ./serve.js --port 3000
+#   ```
 
 set -e
 set -u
index 891fcaa447dcc21ef87ea5b19c83f006c28545e5..f507230ece2aaa17744309a1b1c6bff7b6840426 100644 (file)
@@ -5,6 +5,8 @@
 # tagline: sensible defaults for vim
 # description: |
 #   Think of sensible.vim as one step above 'nocompatible' mode: a universal set of defaults that (hopefully) everyone can agree on.
+# examples: |
+#   N/A
 
 mkdir -p $HOME/.vim/pack/plugins/start
 git clone --depth=1 https://tpope.io/vim/sensible.git $HOME/.vim/pack/plugins/start/sensible
index a89f961b452a741269b697d8691e2d216f16e6de..af6a4d8f45610a14d6af6208722da3384ca27ec8 100644 (file)
@@ -5,6 +5,18 @@
 # tagline: webinstall.dev for the CLI
 # description: |
 #   for the people like us that are too lazy even to run `curl https://webinstall.dev/PACKAGE_NAME` - just `webi PACKAGE_NAME` instead
+# examples: |
+#   ```bash
+#   webi node
+#   ```
+#   <br/>
+#   ```bash
+#   webi golang
+#   ```
+#   <br/>
+#   ```bash
+#   webi rustlang
+#   ```
 
 # TODO webi package@semver#channel