From 0ec5689987d197fdbeac8c481edb3dd2a8615861 Mon Sep 17 00:00:00 2001 From: sogoiii Date: Tue, 22 Nov 2022 11:38:18 -0800 Subject: [PATCH] bump version and fix readme --- README.md | 242 +++++++++++++++++++++++---------------------------- package.json | 2 +- 2 files changed, 108 insertions(+), 136 deletions(-) diff --git a/README.md b/README.md index 8e570516..e4aef51e 100644 --- a/README.md +++ b/README.md @@ -16,73 +16,53 @@ The Holograph CLI enables you to interact with Holograph Protocol, in addition to participating as an operator in the Operator Network. - -- [Overview](#overview) -- [Usage](#usage) -- [Commands](#commands) +* [Overview](#overview) +* [Usage](#usage) +* [Commands](#commands) # Usage - ```sh-session $ npm install -g @holographxyz/cli $ holograph COMMAND running command... $ holograph (--version) -@holographxyz/cli/0.0.9 darwin-arm64 node-v18.9.0 +@holographxyz/cli/0.0.11 darwin-arm64 node-v18.9.0 $ holograph --help [COMMAND] USAGE $ holograph COMMAND ... ``` - # Commands - -- [Overview](#overview) -- [Usage](#usage) -- [Commands](#commands) - - [`holograph bridge`](#holograph-bridge) - - [`holograph bridge:contract`](#holograph-bridgecontract) - - [`holograph bridge:nft`](#holograph-bridgenft) - - [`holograph config`](#holograph-config) - - [`holograph config:networks`](#holograph-confignetworks) - - [`holograph config:user`](#holograph-configuser) - - [`holograph config:view`](#holograph-configview) - - [`holograph create`](#holograph-create) - - [`holograph create:contract`](#holograph-createcontract) - - [`holograph create:nft`](#holograph-createnft) - - [`holograph faucet`](#holograph-faucet) - - [`holograph help [COMMAND]`](#holograph-help-command) - - [`holograph operator`](#holograph-operator) - - [`holograph operator:bond`](#holograph-operatorbond) - - [`holograph operator:recover`](#holograph-operatorrecover) - - [`holograph operator:unbond`](#holograph-operatorunbond) - - [`holograph status`](#holograph-status) - - [`holograph status:contract`](#holograph-statuscontract) - - [`holograph status:nft`](#holograph-statusnft) - - [Developing](#developing) - - [Install Dependencies](#install-dependencies) - - [Working with the code](#working-with-the-code) - - [Branches](#branches) - - [The `mainnet` branch](#the-mainnet-branch) - - [The `testnet` branch](#the-testnet-branch) - - [The `develop` branch](#the-develop-branch) - - [The `experimetnal` branch](#the-experimetnal-branch) - - [Contributing](#contributing) - - [Bugs](#bugs) - - [Suggestions / Desires](#suggestions--desires) - - [Pull Requests](#pull-requests) - - [Official Links](#official-links) +* [`holograph bridge`](#holograph-bridge) +* [`holograph bridge:contract`](#holograph-bridgecontract) +* [`holograph bridge:nft`](#holograph-bridgenft) +* [`holograph config`](#holograph-config) +* [`holograph config:networks`](#holograph-confignetworks) +* [`holograph config:user`](#holograph-configuser) +* [`holograph config:view`](#holograph-configview) +* [`holograph create`](#holograph-create) +* [`holograph create:contract`](#holograph-createcontract) +* [`holograph create:nft`](#holograph-createnft) +* [`holograph faucet`](#holograph-faucet) +* [`holograph help [COMMAND]`](#holograph-help-command) +* [`holograph operator`](#holograph-operator) +* [`holograph operator:bond`](#holograph-operatorbond) +* [`holograph operator:recover`](#holograph-operatorrecover) +* [`holograph operator:unbond`](#holograph-operatorunbond) +* [`holograph status`](#holograph-status) +* [`holograph status:contract`](#holograph-statuscontract) +* [`holograph status:nft`](#holograph-statusnft) ## `holograph bridge` -Make a bridge request +Make a bridge request. ``` USAGE @@ -103,25 +83,18 @@ EXAMPLES Learn how to bridge a Holographable NFT $ holograph bridge:nft --help --env mainnet|testnet|develop|experimental - -COMMANDS - bridge:contract Bridge a Holographable contract from source chain to destination chain. You need to have a deployment config JSON - file. Use the "contract:create" command to create or extract one. - bridge:nft Bridge a Holographable NFT from one network to another. ``` -_See code: [dist/commands/bridge/index.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/bridge/index.ts)_ +_See code: [dist/commands/bridge/index.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.11/dist/commands/bridge/index.ts)_ ## `holograph bridge:contract` Bridge a Holographable contract from source chain to destination chain. You need to have a deployment config JSON file. Use the "contract:create" command to create or extract one. ``` -Bridge a Holographable contract from source chain to destination chain. You need to have a deployment config JSON file. Use the "contract:create" command to create or extract one. - USAGE - $ holograph bridge:contract [--sourceNetwork goerli|mumbai|fuji|rinkeby] [--destinationNetwork goerli|mumbai|fuji|rinkeby] - [--deploymentConfig ] [--env mainnet|testnet|develop|experimental] + $ holograph bridge:contract [--sourceNetwork goerli|mumbai|fuji|rinkeby] [--destinationNetwork + goerli|mumbai|fuji|rinkeby] [--deploymentConfig ] [--env mainnet|testnet|develop|experimental] FLAGS --deploymentConfig= The config file to use @@ -133,23 +106,24 @@ FLAGS DESCRIPTION - Bridge a Holographable contract from source chain to destination chain. You need to have a deployment config JSON file. Use the - "contract:create" command to create or extract one. + Bridge a Holographable contract from source chain to destination chain. You need to have a deployment config JSON + file. Use the "contract:create" command to create or extract one. EXAMPLES $ holograph bridge:contract --sourceNetwork="goerli" --destinationNetwork="fuji" --deploymentConfig="./MyContract.json" --env mainnet|testnet|develop|experimental ``` -_See code: [dist/commands/bridge/contract.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/bridge/contract.ts)_ +_See code: [dist/commands/bridge/contract.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.11/dist/commands/bridge/contract.ts)_ ## `holograph bridge:nft` -Beam a Holographable NFT from source chain to destination chain. +Bridge a Holographable NFT from one network to another. ``` USAGE - $ holograph bridge:nft [--collectionAddress ] [--tokenId ] [--sourceNetwork goerli|mumbai|fuji|rinkeby] - [--destinationNetwork goerli|mumbai|fuji|rinkeby] [--env mainnet|testnet|develop|experimental] + $ holograph bridge:nft [--collectionAddress ] [--tokenId ] [--sourceNetwork + goerli|mumbai|fuji|rinkeby] [--destinationNetwork goerli|mumbai|fuji|rinkeby] [--env + mainnet|testnet|develop|experimental] FLAGS --collectionAddress= The address of the collection smart contract @@ -168,7 +142,7 @@ EXAMPLES $ holograph bridge:nft --sourceNetwork="goerli" --destinationNetwork="fuji" --collectionAddress="0x1318d3420b0169522eB8F3EF0830aceE700A2eda" --tokenId="0x01" --env mainnet|testnet|develop|experimental ``` -_See code: [dist/commands/bridge/nft.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/bridge/nft.ts)_ +_See code: [dist/commands/bridge/nft.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.11/dist/commands/bridge/nft.ts)_ ## `holograph config` @@ -199,92 +173,98 @@ EXAMPLES $ holograph config --fromJson '{"version": "beta3", ...} ``` -_See code: [dist/commands/config/index.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.9/dist/commands/config/index.ts)_ +_See code: [dist/commands/config/index.ts](https://github.com/holographxyz/holograph-cli/blob/v0.0.11/dist/commands/config/index.ts)_ ## `holograph config:networks` -View the current network config +View the current network config. ``` USAGE - $ holograph config:networks [--output clean|json|yaml] + $ holograph config:networks [--output clean|json|yaml] [--env mainnet|testnet|develop|experimental] FLAGS + --env=