chore: doc update

Author: chunteng-web3

README.md

@@ -1,9 +1,39 @@
 # ckb_ssri_cli
+>
+> [[EN/CN] Script-Sourced Rich Information - 来源于 Script 的富信息](https://talk.nervos.org/t/en-cn-script-sourced-rich-information-script/8256): General introduction to SSRI.
+>
+> [`ssri-test`](https://github.com/Hanssen0/ssri-test): First prototype of SSRI-Compliant contract.
+>
+> [`ssri-server`](https://github.com/ckb-devrel/ssri-server): Server for calling SSRI methods.
+>
+
+## About
+
+This is a generic Command Line Interface for general users, moderators, and devs to interact with SSRI-Compliant Contracts deployed on CKB Network.
+
+- Call methods of public traits declared in ckb_ssri_sdk implemented by SSRI-Contracts for a universal interface-based user experience.
+    - e.g. Getting metadata for UDT Tokens;
+    - [ ] TODO: Assemble, sign, and send transactions generated by SSRI methods that has attribute `transaction=true`.
+- Provide additional feature supports for SSRI-Compliant contracts that implement public traits through the help of CCC.
+    - e.g. Transferring UDT Tokens, modifying external pause list for Pausable UDT Tokens;
+- Provide plugin interfaces maintained by authors of SSRI-Compliant contracts for extensibility and consistent user experience.
+- Provide entry point for end-to-end tests for SSRI-Compliant contracts.
+
+## Notes for General Users
+
+- Guidances on usage of each command and options are available by calling with `-h` or `--help` flags.
+- [ ] TODO: Authorizations through `ckb-cli` might be required to use some of the commands or flag options.
+
+## Notes for Developers
+
+- This CLI is built on `oclif` with TypeScript and Node.js, so it should be easy to migrate for integrations in dApps.
+- [ ] TODO: This CLI and plugins should be updatable OTA to maintain a consistent user experience.
+- [ ] Refer to `oclif` for developing new plugins.
 
 =================
 
 <!-- toc -->
-* [ckb_ssri_cli](#ckb_ssri_cli)
+- [ckb_ssri_cli](#ckb_ssri_cli)
 <!-- tocstop -->
 ## Usage
 <!-- usage -->
@@ -21,26 +51,26 @@ USAGE
 <!-- usagestop -->
 ## Commands
 <!-- commands -->
-* [`ckb_ssri_cli config account import [ALIAS]`](#ckb_ssri_cli-config-account-import-alias)
-* [`ckb_ssri_cli config udt register JSONSTRING`](#ckb_ssri_cli-config-udt-register-jsonstring)
-* [`ckb_ssri_cli help [COMMAND]`](#ckb_ssri_cli-help-command)
-* [`ckb_ssri_cli plugins`](#ckb_ssri_cli-plugins)
-* [`ckb_ssri_cli plugins add PLUGIN`](#ckb_ssri_cli-plugins-add-plugin)
-* [`ckb_ssri_cli plugins:inspect PLUGIN...`](#ckb_ssri_cli-pluginsinspect-plugin)
-* [`ckb_ssri_cli plugins install PLUGIN`](#ckb_ssri_cli-plugins-install-plugin)
-* [`ckb_ssri_cli plugins link PATH`](#ckb_ssri_cli-plugins-link-path)
-* [`ckb_ssri_cli plugins remove [PLUGIN]`](#ckb_ssri_cli-plugins-remove-plugin)
-* [`ckb_ssri_cli plugins reset`](#ckb_ssri_cli-plugins-reset)
-* [`ckb_ssri_cli plugins uninstall [PLUGIN]`](#ckb_ssri_cli-plugins-uninstall-plugin)
-* [`ckb_ssri_cli plugins unlink [PLUGIN]`](#ckb_ssri_cli-plugins-unlink-plugin)
-* [`ckb_ssri_cli plugins update`](#ckb_ssri_cli-plugins-update)
-* [`ckb_ssri_cli udt extended mint SYMBOL TOADDRESS TOAMOUNT`](#ckb_ssri_cli-udt-extended-mint-symbol-toaddress-toamount)
-* [`ckb_ssri_cli udt metadata decimals TXHASH INDEX`](#ckb_ssri_cli-udt-metadata-decimals-txhash-index)
-* [`ckb_ssri_cli udt metadata name TXHASH INDEX`](#ckb_ssri_cli-udt-metadata-name-txhash-index)
-* [`ckb_ssri_cli udt metadata symbol TXHASH INDEX`](#ckb_ssri_cli-udt-metadata-symbol-txhash-index)
-* [`ckb_ssri_cli udt pausable enumerate-paused SYMBOL`](#ckb_ssri_cli-udt-pausable-enumerate-paused-symbol)
-* [`ckb_ssri_cli udt pausable is-paused SYMBOL [LOCK_HASH]`](#ckb_ssri_cli-udt-pausable-is-paused-symbol-lock_hash)
-* [`ckb_ssri_cli udt transfer SYMBOL TOADDRESS TOAMOUNT`](#ckb_ssri_cli-udt-transfer-symbol-toaddress-toamount)
+- [`ckb_ssri_cli config account import [ALIAS]`](#ckb_ssri_cli-config-account-import-alias)
+- [`ckb_ssri_cli config udt register JSONSTRING`](#ckb_ssri_cli-config-udt-register-jsonstring)
+- [`ckb_ssri_cli help [COMMAND]`](#ckb_ssri_cli-help-command)
+- [`ckb_ssri_cli plugins`](#ckb_ssri_cli-plugins)
+- [`ckb_ssri_cli plugins add PLUGIN`](#ckb_ssri_cli-plugins-add-plugin)
+- [`ckb_ssri_cli plugins:inspect PLUGIN...`](#ckb_ssri_cli-pluginsinspect-plugin)
+- [`ckb_ssri_cli plugins install PLUGIN`](#ckb_ssri_cli-plugins-install-plugin)
+- [`ckb_ssri_cli plugins link PATH`](#ckb_ssri_cli-plugins-link-path)
+- [`ckb_ssri_cli plugins remove [PLUGIN]`](#ckb_ssri_cli-plugins-remove-plugin)
+- [`ckb_ssri_cli plugins reset`](#ckb_ssri_cli-plugins-reset)
+- [`ckb_ssri_cli plugins uninstall [PLUGIN]`](#ckb_ssri_cli-plugins-uninstall-plugin)
+- [`ckb_ssri_cli plugins unlink [PLUGIN]`](#ckb_ssri_cli-plugins-unlink-plugin)
+- [`ckb_ssri_cli plugins update`](#ckb_ssri_cli-plugins-update)
+- [`ckb_ssri_cli udt extended mint SYMBOL TOADDRESS TOAMOUNT`](#ckb_ssri_cli-udt-extended-mint-symbol-toaddress-toamount)
+- [`ckb_ssri_cli udt metadata decimals TXHASH INDEX`](#ckb_ssri_cli-udt-metadata-decimals-txhash-index)
+- [`ckb_ssri_cli udt metadata name TXHASH INDEX`](#ckb_ssri_cli-udt-metadata-name-txhash-index)
+- [`ckb_ssri_cli udt metadata symbol TXHASH INDEX`](#ckb_ssri_cli-udt-metadata-symbol-txhash-index)
+- [`ckb_ssri_cli udt pausable enumerate-paused SYMBOL`](#ckb_ssri_cli-udt-pausable-enumerate-paused-symbol)
+- [`ckb_ssri_cli udt pausable is-paused SYMBOL [LOCK_HASH]`](#ckb_ssri_cli-udt-pausable-is-paused-symbol-lock_hash)
+- [`ckb_ssri_cli udt transfer SYMBOL TOADDRESS TOAMOUNT`](#ckb_ssri_cli-udt-transfer-symbol-toaddress-toamount)
 
 ## `ckb_ssri_cli config account import [ALIAS]`
 

src/commands/udt/pausable/enumerate-paused.ts

@@ -84,6 +84,5 @@ export default class UDTPausableEnumeratePaused extends Command {
       console.error('Request failed', error)
     }
     // TODO: Prettify response.
-    
   }
 }