Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updating readme #2

Merged
merged 1 commit into from
Aug 23, 2014
Merged

updating readme #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 5 additions & 48 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,51 +15,8 @@ var (

```go
type ApiMsg struct {
Content ContentInfo
Meta struct{ Audio ContentInfo }
}
```


#### func NewApiMsgFromJson

```go
func NewApiMsgFromJson(b []byte) (*ApiMsg, error)
```

#### func (*ApiMsg) Json

```go
func (a *ApiMsg) Json() ([]byte, error)
```

#### type ContentInfo

```go
type ContentInfo struct {
Type string
Data []byte
}
```
# gorevisit
--
import "github.com/revisitors/go.revisit.link"


## Usage

```go
var (
ErrNotImplemented = errors.New("not implemented yet")
)
```

#### type ApiMsg

```go
type ApiMsg struct {
Content *Content
Meta *MetaContent
Content *Content `json:"content"`
Meta *MetaContent `json:"meta"`
}
```

Expand All @@ -84,8 +41,8 @@ Json serializes a gorevisit.ApiMsg back to JSON bytes

```go
type Content struct {
Type string
Data string
Type string `json:"type"`
Data string `json:"data"`
}
```

Expand All @@ -95,7 +52,7 @@ Content contains a type and a byte array and should be an image

```go
type MetaContent struct {
Audio *Content
Audio *Content `json:"audio"`
}
```

Expand Down