Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
tpjg committed Jan 2, 2013
1 parent 0ed0111 commit 5e3d038
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 22 deletions.
5 changes: 3 additions & 2 deletions README.md
Expand Up @@ -35,7 +35,7 @@ func main() {
```

Parts of the library are specifically designed to facilitate projects that use both Ruby and Go. See the "Document Models" below.
To install run `go get github.com/tpjg/goriakpbc` and use import as in the example above. If the Document Models (ORM) features are not needed simply run `rm $GOPATH/src/github.com/tpjg/goriakpbc/*model*.go` after `go get`.
To install run `go get github.com/tpjg/goriakpbc` and use import as in the example above. If the Document Models (ORM) features are not needed simply run `rm $GOPATH/src/github.com/tpjg/goriakpbc/model*.go` after `go get`.

### Documentation

Expand Down Expand Up @@ -114,4 +114,5 @@ err = dev.SaveAs("newkey")
### Licensing
goriakpbc is distributed under the Apache license, see `LICENSE.txt` file or http://www.apache.org/licenses/LICENSE-2.0 for details.
goriakpbc is distributed under the Apache license, see `LICENSE.txt` file or http://www.apache.org/licenses/LICENSE-2.0 for details. The model_json_*.go files are a copy from the original Go distribution with minor changes and are governed by a BSD-style license, see `LICENSE.go.txt`.
9 changes: 5 additions & 4 deletions model_json_decode.go
@@ -1,13 +1,14 @@
package riak

// This file is a minor customization of the original encoding/json package for use in goriakpbc

// Copyright 2010 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// license that can be found in the LICENSE.go.txt file.

// Represents JSON data structure using native Go types: booleans, floats,
// strings, arrays, and maps.

// This file is a minor customization of the original encoding/json package for use in goriakpbc
package riak

import (
"encoding/base64"
"errors"
Expand Down
9 changes: 5 additions & 4 deletions model_json_encode.go
@@ -1,16 +1,17 @@
package riak

// This file is a minor customization of the original encoding/json package for use in goriakpbc

// Copyright 2010 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// license that can be found in the LICENSE.go.txt file.

// Package json implements encoding and decoding of JSON objects as defined in
// RFC 4627.
//
// See "JSON and Go" for an introduction to this package:
// http://golang.org/doc/articles/json_and_go.html

// This file is a minor customization of the original encoding/json package for use in goriakpbc
package riak

import (
"bytes"
"encoding/base64"
Expand Down
9 changes: 5 additions & 4 deletions model_json_indent.go
@@ -1,9 +1,10 @@
// Copyright 2010 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package riak

// This file is a minor customization of the original encoding/json package for use in goriakpbc
package riak

// Copyright 2010 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE.go.txt file.

import "bytes"

Expand Down
9 changes: 5 additions & 4 deletions model_json_scanner.go
@@ -1,9 +1,10 @@
// Copyright 2010 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package riak

// This file is a minor customization of the original encoding/json package for use in goriakpbc
package riak

// Copyright 2010 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE.go.txt file.

// JSON value parser state machine.
// Just about at the limit of what is reasonable to write by hand.
Expand Down
9 changes: 5 additions & 4 deletions model_json_stream.go
@@ -1,9 +1,10 @@
// Copyright 2010 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package riak

// This file is a minor customization of the original encoding/json package for use in goriakpbc
package riak

// Copyright 2010 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE.go.txt file.

import (
"errors"
Expand Down

0 comments on commit 5e3d038

Please sign in to comment.