1 file changed
+46
-22
README.MD
+46
-22
@@ -1,10 +1,18 @@
1
# smbcloud-cli
2
3
-This is a CLI program to access [smbcloud](https://smbcloud.xyz/).
3
+**smbcloud-cli** is a robust, open-source command-line interface (CLI) designed for seamless integration with [smbcloud](https://smbcloud.xyz/)—the modern Next.js deployment platform for businesses and developers. Deploy your Next.js apps with the simplicity of a "git push", and enjoy a developer experience on par with Vercel, Cloudflare, and AWS Amplify.
4
+
5
+## Key Features
6
+
7
+- **Effortless Next.js Deployments:** Instantly deploy your Next.js projects to smbcloud with a single command or via "git push to deploy".
8
+- **Vercel/Cloudflare/AWS Amplify Alternative:** Enterprise-grade platform for modern frontend and full-stack applications.
9
+- **Cross-Platform:** Works on MacOS, Linux, and Windows.
10
+- **Open Source:** MIT-licensed and community-driven.
11
+- **Developer Friendly:** Easy to install, extend, and contribute.
12
13
## Installation
14
7
-One can install this program in different ways.
15
+Choose the installation method that best fits your workflow:
16
17
### With Cargo
18
@@ -19,52 +27,68 @@ brew tap smbcloudXYZ/tap
27
brew install cli
28
```
29
22
-### With NPM
30
+### With NPM/Pnpm/Bun/Deno
31
24
-```
32
+```bash
33
npm i -g @smbcloud/cli
34
```
35
28
-## Update
36
+## Updating
37
30
-Simply rerun the installation command.
38
+Stay up-to-date with the latest features and security patches by rerunning your installation command.
39
32
-## Uninstall
40
+## Uninstallation
41
34
-```bash
42
+Remove smbcloud-cli using your preferred package manager:
43
36
-# With cargo
44
+```bash
45
+# With Cargo
46
cargo uninstall smbcloud-cli
47
39
-# With npm
48
+# With NPM
49
npm uninstall -g @smbcloud/cli
50
51
# With Homebrew
43
-brew untap smbcloudXYZ/tap
52
brew uninstall smbcloudXYZ/tap/cli
53
+brew untap smbcloudXYZ/tap
54
```
55
47
-## Usage:
56
+## Getting Started
57
+
58
+Explore available commands and options:
59
60
```bash
61
smb --help
62
```
63
53
-## Contribution
64
+## Contributing
65
+
66
+We welcome contributions from the community and businesses alike. To get started:
67
+
68
+- Ensure you have the latest Rust toolchain installed.
69
+- Clone this repository.
70
+- Set up your environment variables in `.env.local`.
71
+- Run the CLI locally with `cargo run`.
72
+
73
+For detailed contribution guidelines, please refer to [CONTRIBUTING.md](CONTRIBUTING.md) (coming soon).
74
+
75
+## Why smbcloud-cli?
76
55
-- Setup your Rust tooling.
56
-- Clone the repo.
57
-- Provide the environement variables in the .env.local.
58
-- Run `cargo run`.
77
+- **Next.js First:** Purpose-built for Next.js, with zero-config deployments and instant rollbacks.
78
+- **Git Push to Deploy:** Seamless CI/CD—just push to your git repository and your app is live.
79
+- **Enterprise-Ready:** Built with reliability and scalability in mind.
80
+- **Open Collaboration:** Inspired by industry best practices and the open-source community.
81
+- **Modern CLI Principles:** Follows [12-factor CLI app](https://medium.com/@jdxcode/12-factor-cli-apps-dd3c227a0e46) methodology for maintainability and user experience.
82
83
## Credits
84
62
-This repo is inspired by [Sugar](https://github.com/metaplex-foundation/sugar).
85
+- Inspired by [Sugar](https://github.com/metaplex-foundation/sugar).
86
+- NPM packaging guidance by [orhun.dev](https://blog.orhun.dev/packaging-rust-for-npm/).
87
64
-This repo tries to follow [the 12 factor CLI app](https://medium.com/@jdxcode/12-factor-cli-apps-dd3c227a0e46) principles by Heroku team.
88
+## License
89
66
-NPM support guide by [orhun.dev](https://blog.orhun.dev/packaging-rust-for-npm/).
90
+MIT License. See [LICENSE](LICENSE) for details.
91
68
-## Licence
92
+---
93
70
-MIT.
94
+**smbcloud-cli**: The professional's choice for secure, efficient, and open Next.js cloud deployments—experience the power of "git push to deploy".