Skip to content

Commit a5af382

Browse files
authored
Update go module to reflect repo name change; update license to match scs-key-client (#2)
1 parent 6213d1e commit a5af382

File tree

6 files changed

+21
-39
lines changed

6 files changed

+21
-39
lines changed

LICENSE

-29
This file was deleted.

LICENSE.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# LICENSE
2+
3+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
4+
5+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
6+
7+
1. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
8+
9+
1. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
10+
11+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# SCS Remote-Build Client
1+
# SCS Build Client
22

3-
[![GoDoc](https://godoc.org/github.com/sylabs/scs-remote-build-client?status.svg)](https://godoc.org/github.com/sylabs/scs-remote-build-client)
4-
[![Build Status](https://circleci.com/gh/sylabs/scs-remote-build-client.svg?style=shield)](https://circleci.com/gh/sylabs/workflows/scs-remote-build-client)
5-
[![Go Report Card](https://goreportcard.com/badge/github.com/sylabs/scs-remote-build-client)](https://goreportcard.com/report/github.com/sylabs/scs-remote-build-client)
3+
[![GoDoc](https://godoc.org/github.com/sylabs/scs-build-client?status.svg)](https://godoc.org/github.com/sylabs/scs-build-client)
4+
[![Build Status](https://circleci.com/gh/sylabs/scs-build-client.svg?style=shield)](https://circleci.com/gh/sylabs/workflows/scs-build-client)
5+
[![Go Report Card](https://goreportcard.com/badge/github.com/sylabs/scs-build-client)](https://goreportcard.com/report/github.com/sylabs/scs-build-client)
66

7-
This project provides a Go client for the Singularity Container Services (SCS) Remote-Build Service.
7+
This project provides a Go client for the Singularity Container Services (SCS) Build Service.
88

99
## Quick Start
1010

client/client.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import (
1414

1515
// Config contains the client configuration.
1616
type Config struct {
17-
// Base URL of the service (https://keys.sylabs.io is used if not supplied).
17+
// Base URL of the service (https://build.sylabs.io is used if not supplied).
1818
BaseURL string
1919
// Auth token to include in the Authorization header of each request (if supplied).
2020
AuthToken string
@@ -39,7 +39,7 @@ type Client struct {
3939
HTTPClient *http.Client
4040
}
4141

42-
// NewClient sets up a new Remote-Build Service client with the specified base URL and auth token.
42+
// NewClient sets up a new build service client with the specified base URL and auth token.
4343
func NewClient(cfg *Config) (c *Client, err error) {
4444
if cfg == nil {
4545
cfg = DefaultConfig

client/version.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ type VersionInfo struct {
1919
Version string `json:"version"`
2020
}
2121

22-
// GetVersion gets version information from the Remote-Build Service. The context controls the lifetime of
23-
// the request.
22+
// GetVersion gets version information from the build service. The context
23+
// controls the lifetime of the request.
2424
func (c *Client) GetVersion(ctx context.Context) (vi VersionInfo, err error) {
2525
req, err := c.newRequest(http.MethodGet, pathVersion, "", nil)
2626
if err != nil {

go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module github.com/sylabs/scs-remote-build-client
1+
module github.com/sylabs/scs-build-client
22

33
go 1.12
44

0 commit comments

Comments
 (0)