Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
weynsee committed May 20, 2015
1 parent 4b3e3a0 commit 17f267f
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,27 @@
# go-phrase #

go-phrase is a Go client library for accessing the [PhraseApp API](http://docs.phraseapp.com/api/v1/).
go-phrase is a Go client library for accessing the [PhraseApp API](http://docs.phraseapp.com/api/v1/). It also includes a command line interface that implements all the commands in the [official PhraseApp command-line client](https://github.com/phrase/phrase).

**Documentation:** [![GoDoc](https://godoc.org/github.com/weynsee/go-phrase?status.svg)](https://godoc.org/github.com/weynsee/go-phrase)
**Build Status:** [![Build Status](https://travis-ci.org/weynsee/go-phrase.svg?branch=master)](https://travis-ci.org/weynsee/go-phrase)
**Test Coverage:** [![Test Coverage](https://coveralls.io/repos/weynsee/go-phrase/badge.svg?branch=master)](https://coveralls.io/r/weynsee/go-phrase?branch=master)

go-phrase requires Go version 1.1 or greater.

## Usage ##
## CLI ##

The CLI has 4 commands:

```
init Initializes a phrase project
pull Download the translation files in the current project
push Upload the translation files in the current project to PhraseApp
tags List all the tags in the current project
```

Options and arguments for the commands are the same those used in the [official command-line client](https://github.com/phrase/phrase).

## API ##

```go
import "github.com/weynsee/go-phrase/phrase"
Expand Down

0 comments on commit 17f267f

Please sign in to comment.