From 33374975bbbb0073b4997bb136d318d0b3708442 Mon Sep 17 00:00:00 2001 From: b4b4r07 Date: Fri, 16 Jun 2017 13:09:24 +0900 Subject: [PATCH] Update readme --- .gitignore | 1 + .travis.yml | 5 ++--- README.md | 53 +++-------------------------------------------------- 3 files changed, 6 insertions(+), 53 deletions(-) diff --git a/.gitignore b/.gitignore index a4082a9..6a92fbf 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ bin/gist vendor +dist diff --git a/.travis.yml b/.travis.yml index db559cb..b9b1f9d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -9,7 +9,6 @@ os: - osx before_install: - go get github.com/golang/dep/... - - go get github.com/mitchellh/gox - go get github.com/tcnksm/ghr install: - $GOPATH/bin/dep ensure @@ -19,5 +18,5 @@ branches: only: - master after_success: - - gox -output "dist/{{.OS}}_{{.Arch}}_{{.Dir}}" - - ghr --username b4b4r07 --token $GITHUB_TOKEN --replace $(grep 'Version =' cmd/root.go | sed -E 's/.*"(.+)"$$/\1/') dist/ + - make cross + - ghr --username b4b4r07 --token $GITHUB_TOKEN --replace $(make version) dist/ diff --git a/README.md b/README.md index 321c2c9..45568a3 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@ - + [![Build Status](https://travis-ci.org/b4b4r07/gist.svg?branch=master)](https://travis-ci.org/b4b4r07/gist) > A simple gist editor for CLI -> +> > -## Pros - - Simple and intuitive - Just select and edit gist you want - Can use any editors what you want @@ -22,52 +20,7 @@ ## Usage -Currently gist supports the following commands: - -```console -$ gist help -gist - A simple gist editor for CLI - -Usage: - gist [flags] - gist [command] - -Available Commands: - config Config the setting file - delete Delete gist files - edit Edit the gist file and sync after - new Create a new gist - open Open user's gist - -Flags: - -v, --version show the version and exit - -Use "gist [command] --help" for more information about a command. -``` - -### Configurations - -Well-specified options and user-specific settings can be described in a toml file. It can be changed with the `gist set` command. - -```toml -[Core] - Editor = "vim" - selectcmd = "fzf-tmux --multi:fzf:peco:percol" - tomlfile = "/Users/b4b4r07/.config/gist/config.toml" - user = "b4b4r07" - -[Gist] - token = "your_github_token" - dir = "/Users/b4b4r07/.config/gist/files" - -[Flag] - open_url = false - private = false - verbose = true - show_spinner = true -``` - -This behavior was heavily inspired by [mattn/memo](https://github.com/mattn/memo), thanks! +For more info, see `gist help` and `gist help `. ## Installation