Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
waka committed May 5, 2017
1 parent 9595068 commit 1c22cdf
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 14 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ vet:

lint:
@go get github.com/golang/lint/golint
go list ./... | grep -v vendor | xargs -n1 golint
go list ./... | grep -v vendor | xargs -n1 golint -min_confidence 1.1
55 changes: 42 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,65 @@
# twg

twg is twitter client for cli that written by golang.
twg is twitter client for cli, written by golang.

## Usage
## Install

```
$ go get https://github.com/waka/twg
$ twg
$ go get -u https://github.com/waka/twg-go
```

Homebrew
## Start options

```
$ brew install twg
$ twg -h
Usage:
twg [OPTIONS]
Application Options:
-m, --mode= you can select timeline(default) or mentions or list:slug
-t, --tweet= update your status, and finish
-r, --reload do auto reload by 2 minutes
-v, --version
Help Options:
-h, --help Show this help message
```

## Key binds

`hjkl` - left/down/up/right
`r` - refresh
| Key | Action |
|:-----------|:--------------|
| ctrl + q | Quit app |
| ctrl + r | Reload tweets |
| up or k | Up cursor |
| down or j | Up cursor |
| : | Command mode |
| ctrl + c | Normal mode |

## Build in local machine
## Command mode

- `:tl` - show home timeline
- `:mentions` - show mentions tweets
- `:list {slug}` - show list timeline
- `:tweet {text}` - post tweet
- `:reply {text}` - reply to selected tweet
- `:fav` - fav to selected tweet
- `:rt` - retweet to selected tweet

## Reset access token

resolve dependencies using [dep](https://github.com/golang/dep).
Remove configuration file.

```
$ make deps
$ rm ~/.twg
```

build and run.
## Build in local machine

twg use [dep](https://github.com/golang/dep) to resolve dependencies.

```
$ make deps
$ make
$ bin/twg
$ ./bin/twg
```

0 comments on commit 1c22cdf

Please # to comment.