2 files changed
+71
-1
smbpndk-cli/Cargo.toml
+1
-1
@@ -9,7 +9,7 @@ repository = "https://github.com/smbpndk/smbpndk-cli"
9
documentation = "https://docs.smbpndk.com/cli"
10
keywords = ["cli", "cloud", "web2", "web3", "smbpndk"]
11
categories = ["command-line-utilities", "command-line-interface", "cryptography::cryptocurrencies", "development-tools", "wasm"]
12
-readme = "./../README.md"
12
+readme = "README.md"
13
14
[[bin]]
15
name = "smb"
smbpndk-cli/README.md
new
+70
@@ -0,0 +1,70 @@
1
+# smbpndk-cli
2
+
3
+This is a CLI program to access [SmbPndk](https://smbpndk.com/).
4
+
5
+## Installation
6
+
7
+One can install this program in different ways.
8
+
9
+### With Cargo
10
+
11
+```bash
12
+cargo install smbpndk-cli
13
+```
14
+
15
+### Homebrew (MacOS/Linux)
16
+
17
+```bash
18
+brew tap smbpndk/tap
19
+brew install cli
20
+```
21
+
22
+### With NPM
23
+
24
+```
25
+npm i -g @smbpndk/cli
26
+```
27
+
28
+## Update
29
+
30
+Simply rerun the installation command.
31
+
32
+## Uninstall
33
+
34
+```bash
35
+
36
+# With cargo
37
+cargo uninstall smbpndk-cli
38
+
39
+# With npm
40
+npm uninstall -g @smbpndk/cli
41
+
42
+# With Homebrew
43
+brew untap smbpndk/tap
44
+brew uninstall smbpndk/tap/cli
45
+```
46
+
47
+## Usage:
48
+
49
+```bash
50
+smb --help
51
+```
52
+
53
+## Contribution
54
+
55
+- Setup your Rust tooling.
56
+- Clone the repo.
57
+- Provide the environement variables in the .env.local.
58
+- Run `cargo run`.
59
+
60
+## Credits
61
+
62
+This repo is inspired by [Sugar](https://github.com/metaplex-foundation/sugar).
63
+
64
+This repo tries to follow [the 12 factor CLI app](https://medium.com/@jdxcode/12-factor-cli-apps-dd3c227a0e46) principles by Heroku team.
65
+
66
+NPM support guide by [orhun.dev](https://blog.orhun.dev/packaging-rust-for-npm/).
67
+
68
+## Licence
69
+
70
+MIT.