From fe4aef08bbf6233fde98d852b384e015c12c7907 Mon Sep 17 00:00:00 2001 From: Bo-Yi Wu Date: Tue, 31 May 2016 16:11:13 +0800 Subject: [PATCH] add command usage block. Signed-off-by: Bo-Yi Wu --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index f758a17..5ea9c3e 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ A push notification server using [Gin](https://github.com/gin-gonic/gin) framewo - [Features](#features) - [Basic Usage](#basic-usage) - [Download a binary](#download-a-binary) + - [Command Usage](#command-usage) - [Send Android notification](#send-android-notification) - [Send iOS notification](#send-ios-notification) - [Run gorush web server](#run-gorush-web-server) @@ -101,6 +102,30 @@ How to send push notification using `gorush` command? (Android or iOS) The pre-compiled binaries can be downloaded from [release page](https://github.com/appleboy/gorush/releases). +### Command Usage + +``` +Usage: gorush [options] + +Server Options: + -p, --port Use port for clients (default: 8088) + -c, --config Configuration file + -m, --message Notification message + -t, --token Notification token +iOS Options: + -i, --pem certificate key file path + -P, --password certificate key password + --topic iOS topic + --ios enabled iOS (default: false) + --production iOS production mode (default: false) +Android Options: + -k, --key Android API Key + --android enabled android (default: false) +Common Options: + -h, --help Show this message + -v, --version Show version +``` + ### Send Android notification Send single notification with the following command.