Skip to content

Conversation

@oxtoacart
Copy link
Collaborator

No description provided.

README.md Outdated
@@ -1,17 +1,59 @@
# tailscale-client-go
// Copyright (c) David Bond, Tailscale Inc, & Contributors
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In other repos, e.g., OSS, we've done this by including a reference to the AUTHORS file and listing contributors there. That might be worth preserving here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We had some internal discussion with @willnorris about this back in September and settled on what we have for the OG tailscale-client-go repo. I'm inclined to leave that as-is here.

README.md Outdated

## Current Version
[![Go Reference](https://pkg.go.dev/badge/tailscale.com/client/tailscale/v2.svg)](https://pkg.go.dev/tailscale.com/client/tailscale/v2)
[![Go Report Card](https://goreportcard.com/badge/tailscale.com/client/tailscale/v2)](https://goreportcard.com/report/tailscale.com/client/tailscale/v2)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I probably wouldn't bother with this link, but YMMV.

// SPDX-License-Identifier: MIT

// Package tsclient contains a basic implementation of a client for the Tailscale HTTP API.
// package tailscale contains a basic implementation of a client for the Tailscale HTTP API.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If our goal is to advertise this as the preferred standard client, maybe we should make this more explicit:

Suggested change
// package tailscale contains a basic implementation of a client for the Tailscale HTTP API.
// Package tailscale implements a client for the Tailscale HTTP API.

Nit: Please capitalize "Package".

@oxtoacart oxtoacart force-pushed the percy/removev1 branch 2 times, most recently from cca8327 to 487390b Compare February 6, 2025 19:28
@@ -1,17 +1,55 @@
# tailscale-client-go
# tailscale.com/client/tailscale/v2
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

out of curiosity, how are we pulling that off? Are we planning to serve different go-get metadata at that URL? (sorry, I'm behind on the latest client package naming discussions)

@oxtoacart oxtoacart merged commit 299d9b1 into main Feb 6, 2025
2 checks passed
@oxtoacart oxtoacart deleted the percy/removev1 branch February 6, 2025 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants