diff --git a/README.md b/README.md index 6903b50..a2e0518 100644 --- a/README.md +++ b/README.md @@ -1 +1,78 @@ -# web3data-cli +# ๐ŸŒ Web3 Data CLI + +A simple, secure, and extensible command-line tool written in Go for managing Web3-related data. + +**Web3 Data CLI** (`web3datacli`) helps you handle sensitive data through strong AES encryption and enables seamless file sharing via IPFS. + +--- + +## โœจ Features + +- ๐Ÿ” AES encryption & decryption (256-bit) +- ๐Ÿ—‚ Local key generation and management +- ๐Ÿ“ค File uploads and download to IPFS +- ๐Ÿงฉ Built with extensibility in mind โ€” easy to plug in more Web3 features +- ๐Ÿ’ป Native binaries for Linux and macOS + +--- + +## ๐Ÿ“ฆ Installation + +Download the latest binary from the [Releases](https://github.com/your-org/web3datacli/releases) page. + +### Linux + +```bash +wget https://github.com/your-org/web3datacli/releases/latest/download/web3datacli-linux -O web3datacli +chmod +x web3datacli +sudo mv web3datacli /usr/local/bin/web3datacli +``` + +### macOS + +```bash +wget https://github.com/your-org/web3datacli/releases/latest/download/web3datacli-darwin -O web3datacli +chmod +x web3datacli +sudo mv web3datacli /usr/local/bin/web3datacli +``` + +--- + +## ๐Ÿš€ Usage + +```bash +web3datacli [command] +``` + +### Available Commands + +| Command | Description | +|--------------|----------------------------------------| +| `encryption` | ๐Ÿ” Manage data encryption and decryption | +| `ipfs` | ๐Ÿ“ค Interact with IPFS | +| `version` | Show the CLI version | +| `completion` | Generate autocompletion for your shell | +| `help` | Help about any command | + +--- + +## ๐Ÿง  Autocompletion + +Enable autocompletion for your shell (e.g., bash, zsh): + +```bash +web3datacli completion bash > /etc/bash_completion.d/web3datacli +source /etc/bash_completion.d/web3datacli +``` + +--- + +## ๐Ÿงพ License + +MIT License ยฉ 2025 F.CORDIER + +--- + +## ๐Ÿค Contributions + +Feel free to open issues or submit PRs โ€” contributions are welcome! \ No newline at end of file diff --git a/cmd/ipfs/ipfs.go b/cmd/ipfs/ipfs.go index 60fa282..a7870ee 100644 --- a/cmd/ipfs/ipfs.go +++ b/cmd/ipfs/ipfs.go @@ -17,7 +17,7 @@ var ( var IPFSCmd = &cobra.Command{ Use: "ipfs", - Short: "Interact with IPFS", + Short: "๐Ÿ“ค Interact with IPFS", } func init() {