update README.md

README.md

@@ -27,26 +27,58 @@ PDU是基于点对点的方式构建社交网络服务，系统中所有信息
 ## Usage
 
 ```
-Parallel Digital Universe
-	A decentralized social networking service
-	Website: https://pdu.pub
+Run node daemon
 
 Usage:
-  pdu [command]
+  pdu run [loop interval] [flags]
+
+Flags:
+  -h, --help           help for run
+      --interval int   time interval between consecutive processing on node (default 5)
+
+Global Flags:
+      --fbKeyPath string     path of firebase json key (default "udb/fb/test-firebase-adminsdk.json")
+      --fbProjectID string   project ID (default "pdupub-a2bdd")
+      --projectPath string   project root path (default "./")
+```
+
+```
+Operations on node
+
+Usage:
+  pdu node [command]
 
 Available Commands:
-  ck          Create keystores
-  completion  Generate the autocompletion script for the specified shell
-  help        Help about any command
-  send        Send sampel msg to node
-  start       Start run node
-  test        Test some methods
+  backup      Backup processed quantums to local
+  exe         Do process quantum once on node
+  hide        Hide processed Quantum in node
+  judge       Judge Individual & Community on your own node
+  truncate    Clear up all data on firebase collections
 
 Flags:
-  -h, --help                 help for pdu
+  -h, --help   help for node
+
+Global Flags:
+      --fbKeyPath string     path of firebase json key (default "udb/fb/test-firebase-adminsdk.json")
+      --fbProjectID string   project ID (default "pdupub-a2bdd")
       --projectPath string   project root path (default "./")
 
-Use "pdu [command] --help" for more information about a command.
+Use "pdu node [command] --help" for more information about a command.
+```
+
+```
+Create and Broadcast Message (For test your own node)
+
+Usage:
+  pdu msg [flags]
+
+Flags:
+  -h, --help   help for msg
+
+Global Flags:
+      --fbKeyPath string     path of firebase json key (default "udb/fb/test-firebase-adminsdk.json")
+      --fbProjectID string   project ID (default "pdupub-a2bdd")
+      --projectPath string   project root path (default "./")
 ```
 
 

cmd/pdu/key.go

@@ -36,7 +36,7 @@ var (
 func KeyCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "key [keystore_path]",
-		Short: "Operations on keystores",
+		Short: "Create keystores (For test)",
 		Args:  cobra.ExactArgs(1),
 		RunE: func(_ *cobra.Command, args []string) error {
 			pass, salt, err := getPassAndSalt()

cmd/pdu/msg.go

@@ -36,7 +36,7 @@ import (
 func MsgCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "msg",
-		Short: "Operations on message",
+		Short: "Create and Broadcast Message (For test your own node)",
 		Args:  cobra.RangeArgs(0, 1),
 		RunE: func(_ *cobra.Command, args []string) (err error) {
 			var currentDID *identity.DID

cmd/pdu/node.go

@@ -42,7 +42,7 @@ func NodeCmd() *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:   "node",
-		Short: "Perform some actions on the node",
+		Short: "Operations on node",
 	}
 	cmd.Flags().StringVar(&firebaseKeyPath, "fbKeyPath", params.TestFirebaseAdminSDKPath, "path of firebase json key")
 	cmd.Flags().StringVar(&firebaseProjectID, "fbProjectID", params.TestFirebaseProjectID, "project ID")

cmd/pdu/run.go

@@ -31,7 +31,7 @@ func RunCmd() *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:   "run [loop interval]",
-		Short: "Start to run node daemon",
+		Short: "Run node daemon",
 		Args:  cobra.NoArgs,
 		RunE: func(_ *cobra.Command, args []string) error {
 

udb/fb/universe.go

@@ -616,6 +616,7 @@ func (fbu *FBUniverse) HideProcessedQuantum(sig core.Sig) error {
 }
 
 // GetQuantums is not belong to interface of core/universe
+// this function can be used to backup data by node owner or download data from node by user
 func (fbu *FBUniverse) GetQuantums(limit int, skip int, desc bool) ([]*core.Quantum, error) {
 	var qs []*core.Quantum
 	quantumQuery := fbu.quantumC.Query.Where("seq", ">", 0)