Skip to content

Commit 9206e9a

Browse files
authored
docs(librarian): add more links and details to README (#2315)
Fixes: #2310
1 parent 21922f3 commit 9206e9a

File tree

1 file changed

+35
-15
lines changed

1 file changed

+35
-15
lines changed

README.md

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
[![codecov](https://codecov.io/github/googleapis/librarian/graph/badge.svg?token=33d3L7Y0gN)](https://codecov.io/github/googleapis/librarian)
21
# Librarian CLI
32

3+
[![Go Reference](https://pkg.go.dev/badge/github.com/googleapis/librarian/cmd/librarian.svg)](https://pkg.go.dev/github.com/googleapis/librarian/cmd/librarian)
4+
[![codecov](https://codecov.io/github/googleapis/librarian/graph/badge.svg?token=33d3L7Y0gN)](https://codecov.io/github/googleapis/librarian)
5+
46
This repository contains code for a unified command line tool for
57
Google Cloud SDK client library configuration, generation and releasing.
68

@@ -13,35 +15,53 @@ intended to discourage anyone from reading the code and documentation;
1315
it's only to set expectations. (For example, we're unlikely to accept
1416
feature requests for external use cases.)
1517

18+
## Installation
19+
20+
Install [Go](https://go.dev/doc/install) and make sure you have you have the
21+
following in your `PATH`:
22+
23+
```sh
24+
export PATH="$(go env GOPATH)/bin:$PATH"
25+
```
26+
27+
Next install the CLI
28+
29+
```sh
30+
go install github.com/googleapis/librarian/cmd/librarian@latest
31+
```
32+
1633
## Running Librarian
1734

1835
To see the current set of commands available, run:
1936

2037
```sh
21-
go run ./cmd/librarian
38+
librarian -help
2239
```
2340

24-
Use the `-h` flag for any individual command to see detailed
41+
Use the `-help` or `-h` flag for any individual command to see detailed
2542
documentation for its purpose and associated flags. For example:
2643

2744
```sh
28-
go run ./cmd/librarian generate -h
45+
librarian generate -h
2946
```
3047

31-
Most commands require a language-specific image to be available;
32-
there are no such images published at the moment.
48+
Alternatively, if you prefer not to have librarian installed you can use the Go
49+
command to run the latest released version:
3350

34-
See https://pkg.go.dev/github.com/googleapis/librarian/cmd/librarian for
35-
additional documentation.
51+
```sh
52+
go run github.com/googleapis/librarian/cmd/librarian@latest -help
53+
```
3654

37-
## Running Tests
55+
## Documentation
3856

39-
See [testing.md] for more information.
57+
- [CLI Documentation](https://pkg.go.dev/github.com/googleapis/librarian/cmd/librarian)
58+
- [Language Onboarding Guide](doc/language-onboarding.md)
59+
- [How We Write Go](doc/howwewritego.md)
60+
- [State Schema](doc/state-schema.md)
61+
- [Config Schema](doc/config-schema.md))
62+
- [Running Tests](doc/testing.md)
63+
- [sidekick](doc/sidekick.md)
4064

4165
## License
4266

43-
Apache 2.0 - See [LICENSE] for more information.
44-
45-
[contributing]: CONTRIBUTING.md
46-
[license]: LICENSE
47-
[testing.md]: doc/testing.md
67+
Apache 2.0 - See [LICENSE](LICENSE) for more information.

0 commit comments

Comments
 (0)