File: README.md

package info (click to toggle)
golang-github-joyent-gosign 0.0~git20161114.9abcee2-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 96 kB
  • sloc: makefile: 2
file content (73 lines) | stat: -rw-r--r-- 2,260 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
gosign
======

Go HTTP signing library for Joyent's Triton and Manta.

## Installation

Use `go-get` to install gosign
```
go get github.com/joyent/gosign
```

## Documentation

Documentation can be found on godoc.

- [github.com/joyent/gosign](http://godoc.org/github.com/joyent/gosign)
- [github.com/joyent/gosign/auth](http://godoc.org/github.com/joyent/gosign/auth)


## Contributing

Report bugs and request features using [GitHub Issues](https://github.com/joyent/gosign/issues), or contribute code via a [GitHub Pull Request](https://github.com/joyent/gosign/pulls). Changes will be code reviewed before merging. In the near future, automated tests will be run, but in the meantime please `go fmt`, `go lint`, and test all contributions.


## Developing

This library assumes a Go development environment setup based on [How to Write Go Code](https://golang.org/doc/code.html). Your GOPATH environment variable should be pointed at your workspace directory.

You can now use `go get github.com/joyent/gosign` to install the repository to the correct location, but if you are intending on contributing back a change you may want to consider cloning the repository via git yourself. This way you can have a single source tree for all Joyent Go projects with each repo having two remotes -- your own fork on GitHub and the upstream origin.

For example if your GOPATH is `~/src/joyent/go` and you're working on multiple repos then that directory tree might look like:

```
~/src/joyent/go/
|_ pkg/
|_ src/
   |_ github.com
      |_ joyent
         |_ gocommon
         |_ gomanta
         |_ gosdc
         |_ gosign
```

### Recommended Setup

```
$ mkdir -p ${GOPATH}/src/github.com/joyent
$ cd ${GOPATH}/src/github.com/joyent
$ git clone git@github.com:<yourname>/gosign.git
$ cd gosign
$ git remote add upstream git@github.com:joyent/gosign.git
$ git remote -v
origin  git@github.com:<yourname>/gosign.git (fetch)
origin  git@github.com:<yourname>/gosign.git (push)
upstream        git@github.com:joyent/gosign.git (fetch)
upstream        git@github.com:joyent/gosign.git (push)
```

### Run Tests

```
cd ${GOPATH}/src/github.com/joyent/gosign
go test ./...
```

### Build the Library

```
cd ${GOPATH}/src/github.com/joyent/gosign
go build ./...
```