2 files changed
+84
-15
.github/workflows/release-homebrew.yml
+12
-10
@@ -169,30 +169,32 @@ jobs:
169
mkdir -p homebrew-tap/Formula
170
171
cat > homebrew-tap/Formula/cli.rb <<FORMULA
172
+ # frozen_string_literal: true
173
+
174
# Homebrew formula for the smbCloud CLI (\`smb\` binary).
175
class Cli < Formula
174
- desc "smbCloud command line interface"
175
- homepage "https://github.com/${REPO}"
176
- version "${VERSION}"
177
- license "Apache-2.0"
176
+ desc 'smbCloud command line interface'
177
+ homepage 'https://github.com/${REPO}'
178
+ version '${VERSION}'
179
+ license 'Apache-2.0'
180
181
on_macos do
182
on_arm do
181
- url "https://github.com/${REPO}/releases/download/${TAG}/smb-macos-arm64.tar.gz"
182
- sha256 "${ARM64_SHA}"
183
+ url 'https://github.com/${REPO}/releases/download/${TAG}/smb-macos-arm64.tar.gz'
184
+ sha256 '${ARM64_SHA}'
185
end
186
on_intel do
185
- url "https://github.com/${REPO}/releases/download/${TAG}/smb-macos-amd64.tar.gz"
186
- sha256 "${AMD64_SHA}"
187
+ url 'https://github.com/${REPO}/releases/download/${TAG}/smb-macos-amd64.tar.gz'
188
+ sha256 '${AMD64_SHA}'
189
end
190
end
191
192
def install
191
- bin.install "smb"
193
+ bin.install 'smb'
194
end
195
196
test do
195
- system "#{bin}/smb", "--help"
197
+ system "#{bin}/smb", '--help'
198
end
199
end
200
FORMULA
README.MD
+72
-5
@@ -5,21 +5,88 @@
5
<br>smbCloud CLI
6
</h1>
7
<p align="center">
8
+ Deploy to the cloud in one command.
9
<br />
9
- <a href="#about">About</a>
10
- ·
11
- <a href="#license">License</a>
10
+ <br />
11
+ <a href="https://www.smbcloud.xyz/">Website</a>
12
·
13
<a href="./docs">Documentation</a>
14
·
15
<a href="CONTRIBUTING.md">Contributing</a>
16
+ ·
17
+ <a href="https://github.com/smbcloudXYZ/smbcloud-cli/releases">Releases</a>
18
+ </p>
19
+ <p align="center">
20
+ <a href="https://crates.io/crates/smbcloud-cli"><img alt="crates.io" src="https://img.shields.io/crates/v/smbcloud-cli"></a>
21
+ <a href="https://www.npmjs.com/package/@smbcloud/cli"><img alt="npm" src="https://img.shields.io/npm/v/@smbcloud/cli"></a>
22
+ <a href="https://pypi.org/project/smbcloud-cli/"><img alt="PyPI" src="https://img.shields.io/pypi/v/smbcloud-cli"></a>
23
+ <a href="https://github.com/smbcloudXYZ/smbcloud-cli/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/smbcloudXYZ/smbcloud-cli"></a>
24
</p>
25
</p>
26
27
## About
28
21
-**smbcloud-cli** is a robust, open-source command-line interface (CLI) for [smbcloud](https://smbcloud.xyz/)—the modern cloud deployment platform. Deploy your Rust, NodeJs, Ruby, or Swift apps with one command: `smb`.
29
+**`smb`** is the command-line interface for [smbCloud](https://www.smbcloud.xyz/) — the modern cloud deployment platform. Ship your Rust, Node.js, Ruby, or Swift app with a single command.
30
+
31
+## Install
32
+
33
+### Homebrew (macOS)
34
+
35
+```sh
36
+brew tap smbcloudXYZ/homebrew-tap
37
+brew install cli
38
+```
39
+
40
+### npm
41
+
42
+```sh
43
+npm install -g @smbcloud/cli
44
+```
45
+
46
+### pip
47
+
48
+```sh
49
+pip install smbcloud-cli
50
+```
51
+
52
+### Cargo
53
+
54
+```sh
55
+cargo install smbcloud-cli
56
+```
57
+
58
+### Shell (macOS / Linux)
59
+
60
+```sh
61
+curl -fsSL https://raw.githubusercontent.com/smbcloudXYZ/smbcloud-cli/main/install-unix.sh | sh
62
+```
63
+
64
+### PowerShell (Windows)
65
+
66
+```powershell
67
+irm https://raw.githubusercontent.com/smbcloudXYZ/smbcloud-cli/main/install-windows.sh | iex
68
+```
69
+
70
+Or grab a pre-built binary from the [Releases](https://github.com/smbcloudXYZ/smbcloud-cli/releases) page.
71
+
72
+## Quick Start
73
+
74
+```sh
75
+smb login
76
+smb init
77
+smb deploy
78
+```
79
+
80
+That's it. Your app is live.
81
+
82
+## Documentation
83
+
84
+See the [`docs/`](./docs) directory for guides on authentication, project configuration, and deployment workflows.
85
+
86
+## Contributing
87
+
88
+Read [CONTRIBUTING.md](CONTRIBUTING.md) to get started. All contributions are welcome.
89
90
## License
91
25
-MIT
92
+[Apache-2.0](LICENSE)