Skip to content

Commit 75f6a9f

Browse files
jpoehneltjpoehnelt
committed
docs(README): cleanup root readme file
1 parent 51a324f commit 75f6a9f

File tree

1 file changed

+40
-19
lines changed

1 file changed

+40
-19
lines changed

‎README.md‎

Lines changed: 40 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,55 @@
1+
# Google Workspace Go Samples
2+
3+
[![Build Status](https://github.com/googleworkspace/go-samples/actions/workflows/test.yml/badge.svg)](https://github.com/googleworkspace/go-samples/actions/workflows/test.yml)
4+
[![Lint Status](https://github.com/googleworkspace/go-samples/actions/workflows/lint.yml/badge.svg)](https://github.com/googleworkspace/go-samples/actions/workflows/lint.yml)
5+
[![Go Report Card](https://goreportcard.com/badge/github.com/googleworkspace/go-samples)](https://goreportcard.com/report/github.com/googleworkspace/go-samples)
6+
17
Go samples for [Google Workspace APIs](https://developers.google.com/gsuite/) docs.
28

3-
To run the quickstarts, download a `credentials.json` file in the `quickstart`
4-
folder by following the instructions in `quickstart/README.md`.
9+
To run the quickstarts, download a `credentials.json` file in the `quickstart` folder by following the instructions in `quickstart/README.md`.
510

611
## APIs
712

8-
| | **Apps Script** | **Calendar** | **Classroom** | **Docs** | **Drive V3** | **Gmail** | **Sheets** | **Slides** | **Tasks** |
9-
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
10-
| GoDoc | [![GoDoc](https://godoc.org/google.golang.org/api/script/v1?status.svg)](https://godoc.org/google.golang.org/api/script/v1) | [![GoDoc](https://godoc.org/google.golang.org/api/calendar/v1?status.svg)](https://godoc.org/google.golang.org/api/calendar/v1) | [![GoDoc](https://godoc.org/google.golang.org/api/classroom/v1?status.svg)](https://godoc.org/google.golang.org/api/classroom/v1) | [![GoDoc](https://godoc.org/google.golang.org/api/docs/v1?status.svg)](https://godoc.org/google.golang.org/api/docs/v1) | [![GoDoc](https://godoc.org/google.golang.org/api/drive/v3?status.svg)](https://godoc.org/google.golang.org/api/drive/v3) | [![GoDoc](https://godoc.org/google.golang.org/api/gmail/v1?status.svg)](https://godoc.org/google.golang.org/api/gmail/v1) | [![GoDoc](https://godoc.org/google.golang.org/api/sheets/v4?status.svg)](https://godoc.org/google.golang.org/api/sheets/v4) | [![GoDoc](https://godoc.org/google.golang.org/api/slides/v1?status.svg)](https://godoc.org/google.golang.org/api/slides/v1) | [![GoDoc](https://godoc.org/google.golang.org/api/tasks/v1?status.svg)](https://godoc.org/google.golang.org/api/tasks/v1) |
11-
| Quickstart | [Link](https://developers.google.com/apps-script/api/quickstart/go) | [Link](https://developers.google.com/calendar/quickstart/go) | [Link](https://developers.google.com/classroom/quickstart/go) | [Link](https://developers.google.com/docs/api/quickstart/go) | [Link](https://developers.google.com/drive/v3/web/quickstart/go) | [Link](https://developers.google.com/gmail/api/quickstart/go) | [Link](https://developers.google.com/sheets/api/quickstart/go) | [Link](https://developers.google.com/slides/quickstart/go) | [Link](https://developers.google.com/google-apps/tasks/quickstart/go) |
12-
| Snippets | --- | --- | --- | --- | [Link](https://developers.google.com/drive/v3/web/about-sdk) | --- | --- | [Link](https://developers.google.com/slides/how-tos/overview) | --- |
13+
| API | GoDoc | Quickstart | Snippets |
14+
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------- |
15+
| **Admin SDK Directory** | [![GoDoc](https://godoc.org/google.golang.org/api/admin/directory/v1?status.svg)](https://godoc.org/google.golang.org/api/admin/directory/v1) | [Link](https://developers.google.com/admin-sdk/directory/v1/quickstart/go) | - |
16+
| **Admin SDK Reports** | [![GoDoc](https://godoc.org/google.golang.org/api/admin/reports/v1?status.svg)](https://godoc.org/google.golang.org/api/admin/reports/v1) | [Link](https://developers.google.com/admin-sdk/reports/v1/quickstart/go) | - |
17+
| **Admin SDK Reseller** | [![GoDoc](https://godoc.org/google.golang.org/api/reseller/v1?status.svg)](https://godoc.org/google.golang.org/api/reseller/v1) | [Link](https://developers.google.com/admin-sdk/reseller/v1/quickstart/go) | - |
18+
| **Apps Script** | [![GoDoc](https://godoc.org/google.golang.org/api/script/v1?status.svg)](https://godoc.org/google.golang.org/api/script/v1) | [Link](https://developers.google.com/apps-script/api/quickstart/go) | - |
19+
| **Calendar** | [![GoDoc](https://godoc.org/google.golang.org/api/calendar/v1?status.svg)](https://godoc.org/google.golang.org/api/calendar/v1) | [Link](https://developers.google.com/calendar/quickstart/go) | - |
20+
| **Classroom** | [![GoDoc](https://godoc.org/google.golang.org/api/classroom/v1?status.svg)](https://godoc.org/google.golang.org/api/classroom/v1) | [Link](https://developers.google.com/classroom/quickstart/go) | - |
21+
| **Docs** | [![GoDoc](https://godoc.org/google.golang.org/api/docs/v1?status.svg)](https://godoc.org/google.golang.org/api/docs/v1) | [Link](https://developers.google.com/docs/api/quickstart/go) | - |
22+
| **Drive V3** | [![GoDoc](https://godoc.org/google.golang.org/api/drive/v3?status.svg)](https://godoc.org/google.golang.org/api/drive/v3) | [Link](https://developers.google.com/drive/v3/web/quickstart/go) | [Link](https://developers.google.com/drive/v3/web/about-sdk) |
23+
| **Gmail** | [![GoDoc](https://godoc.org/google.golang.org/api/gmail/v1?status.svg)](https://godoc.org/google.golang.org/api/gmail/v1) | [Link](https://developers.google.com/gmail/api/quickstart/go) | - |
24+
| **People** | [![GoDoc](https://godoc.org/google.golang.org/api/people/v1?status.svg)](https://godoc.org/google.golang.org/api/people/v1) | [Link](https://developers.google.com/people/quickstart/go) | - |
25+
| **Sheets** | [![GoDoc](https://godoc.org/google.golang.org/api/sheets/v4?status.svg)](https://godoc.org/google.golang.org/api/sheets/v4) | [Link](https://developers.google.com/sheets/api/quickstart/go) | - |
26+
| **Slides** | [![GoDoc](https://godoc.org/google.golang.org/api/slides/v1?status.svg)](https://godoc.org/google.golang.org/api/slides/v1) | [Link](https://developers.google.com/slides/quickstart/go) | [Link](https://developers.google.com/slides/how-tos/overview) |
27+
| **Tasks** | [![GoDoc](https://godoc.org/google.golang.org/api/tasks/v1?status.svg)](https://godoc.org/google.golang.org/api/tasks/v1) | [Link](https://developers.google.com/google-apps/tasks/quickstart/go) | - |
1328

14-
### Admin SDK APIs
29+
## Development
1530

16-
- [Directory Quickstart](https://developers.google.com/admin-sdk/directory/v1/quickstart/go) [![GoDoc](https://godoc.org/google.golang.org/api/admin/directory/v1?status.svg)](https://godoc.org/google.golang.org/api/admin/directory/v1)
17-
- [Reports Quickstart](https://developers.google.com/admin-sdk/reports/v1/quickstart/go) [![GoDoc](https://godoc.org/google.golang.org/api/admin/reports/v1?status.svg)](https://godoc.org/google.golang.org/api/admin/reports/v1)
18-
- [Reseller Quickstart](https://developers.google.com/admin-sdk/reseller/v1/quickstart/go) [![GoDoc](https://godoc.org/google.golang.org/api/reseller/v1?status.svg)](https://godoc.org/google.golang.org/api/reseller/v1)
31+
Use the following commands to maintain the repository:
1932

20-
## Build
33+
### Format
2134

22-
`go build -v ./...`
35+
```bash
36+
go fmt ./...
37+
```
2338

24-
## Format
39+
### Build
2540

26-
`go fmt ./...`
41+
```bash
42+
go build -v ./...
43+
```
2744

28-
## Vet
45+
### Vet
2946

30-
`go vet ./...`
47+
```bash
48+
go vet ./...
49+
```
3150

32-
## Tidy
51+
### Tidy
3352

34-
`go mod tidy`
53+
```bash
54+
go mod tidy
55+
```

0 commit comments

Comments
 (0)