From ce3b090266186ea476abecf75611efdc7d79ada2 Mon Sep 17 00:00:00 2001 From: Kazuki Hara Date: Sun, 30 May 2021 09:44:26 +0900 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++++-- SupportEvent.md | 11 +++++++++++ main.go | 4 ++-- 3 files changed, 24 insertions(+), 4 deletions(-) create mode 100644 SupportEvent.md diff --git a/README.md b/README.md index a2d334b..a06e5f7 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ go-circle-list-extract extracts a circle list of Comitia in JSON or CSV format. ## Install from binary -Donwload from [release page](https://github.com/hk220/go-circle-list-extract/releases.) +Donwload a binary according to your OS and config.yaml from [release page](https://github.com/hk220/go-circle-list-extract/releases.) ## Install from source @@ -15,7 +15,14 @@ go install github.com/hk220/go-circle-list-extract ## Usage ```bash -go-circle-list-extract -f [format:json, csv] -o [output filename] [eventname] +Usage: + go-circle-list-extract [event name] [flags] + +Flags: + -c, --config string config file (default is config.yaml) (default "config.yaml") + -f, --format string output format (support: json, csv) (default "csv") + -h, --help help for go-circle-list-extract + -o, --output string output file name (default "circles.csv") ``` ## Support Event @@ -24,3 +31,5 @@ See config.yaml - Comitia 134: event name is `comitia134` - Comitia 136: event name is `comitia136` + +To see the old events, look at [SupportEvent.md](SupportEvent.md) diff --git a/SupportEvent.md b/SupportEvent.md new file mode 100644 index 0000000..f00fdc6 --- /dev/null +++ b/SupportEvent.md @@ -0,0 +1,11 @@ +# Older Support Event + +Maybe the link is broken and you can't extract it. + +- Comitia 125: event name is `comitia125` +- Comitia 126: event name is `comitia126` +- Comitia 127: event name is `comitia127` +- Comitia 128: event name is `comitia128` +- Comitia 129: event name is `comitia129` +- Comitia 130: event name is `comitia130` +- Comitia 131: event name is `comitia131` \ No newline at end of file diff --git a/main.go b/main.go index d240515..3a64697 100644 --- a/main.go +++ b/main.go @@ -18,7 +18,7 @@ var ( cfgFile string rootCmd = &cobra.Command{ - Use: "go-circle-list-extract", + Use: "go-circle-list-extract [event name]", Short: "go-circle-list-extract extracts a circle list of Comitia in JSON or CSV format.", Args: cobra.ExactArgs(1), Run: func(cmd *cobra.Command, args []string) { @@ -86,7 +86,7 @@ func init() { cobra.OnInitialize(initConfig) rootCmd.PersistentFlags().StringVarP(&cfgFile, "config", "c", "config.yaml", "config file (default is config.yaml)") - rootCmd.PersistentFlags().StringP("format", "f", "csv", "output format") + rootCmd.PersistentFlags().StringP("format", "f", "csv", "output format (support: json, csv)") rootCmd.PersistentFlags().StringP("output", "o", "circles.csv", "output file name") viper.BindPFlag("format", rootCmd.PersistentFlags().Lookup("format")) viper.BindPFlag("output", rootCmd.PersistentFlags().Lookup("output"))