Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
babarot committed Jun 16, 2017
1 parent 1c35e18 commit 3337497
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 53 deletions.
1 change: 1 addition & 0 deletions .gitignore
@@ -1,2 +1,3 @@
bin/gist
vendor
dist
5 changes: 2 additions & 3 deletions .travis.yml
Expand Up @@ -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
Expand All @@ -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/
53 changes: 3 additions & 50 deletions README.md
@@ -1,11 +1,9 @@
<a href="https://gist.github.com"><img src="https://raw.githubusercontent.com/b4b4r07/i/master/gist/logo.png" width="200"></a>
<a href="https://gist.github.com"><img src="https://raw.githubusercontent.com/b4b4r07/i/master/gist/logo.png" width="200"></a> [![Build Status](https://travis-ci.org/b4b4r07/gist.svg?branch=master)](https://travis-ci.org/b4b4r07/gist)

> A simple gist editor for CLI
>
>
> <a href="https://github.com/b4b4r07/gist"><img src="https://octodex.github.com/images/megacat-2.png" width="200"></a>
## Pros

- Simple and intuitive
- Just select and edit gist you want
- Can use any editors what you want
Expand All @@ -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 <cmd>`.

## Installation

Expand Down

0 comments on commit 3337497

Please sign in to comment.