Skip to content

Commit 3467b70

Browse files
authored
Merge pull request #513 from zenhack/tidy-readme
Tidy up the README & remove stuff redundant with docs/
2 parents 696b9be + 9b7887c commit 3467b70

File tree

1 file changed

+8
-38
lines changed

1 file changed

+8
-38
lines changed

README.md

Lines changed: 8 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -17,48 +17,18 @@ This package provides:
1717

1818
Support for Level 3 RPC is [planned](https://github.com/capnproto/go-capnproto2/issues/160).
1919

20-
[godoc]: http://pkg.go.dev/capnproto.org/go/capnp/v3
21-
## Installation
22-
23-
#### To interact with pre-compiled schemas
24-
25-
Ensure that Go modules are enabled, then run the following command:
26-
```
27-
$ go get capnproto.org/go/capnp/v3
28-
```
29-
30-
#### To compile Cap'n Proto schema files to Go
31-
32-
Two additional steps are needed to compile `.capnp` files to Go:
33-
34-
1. [Install the Cap'n Proto tools](https://capnproto.org/install.html).
35-
2. Install the Go language bindings by running:
36-
```bash
37-
go install capnproto.org/go/capnp/v3/capnpc-go@latest # install go compiler plugin
38-
GO111MODULE=off go get -u capnproto.org/go/capnp/v3/ # install go-capnproto to $GOPATH
39-
```
40-
41-
To learn how to compile a simple schema, [click here](docs/Getting-Started.md#compiling-schema-files).
42-
43-
This package has been tested with version `0.8.0` of the `capnp` tool.
20+
## Getting Started
4421

45-
## Documentation
22+
Read the ["Getting Started" guide](docs/Getting-Started.md#remote-calls-using-interfaces)
23+
for a high-level introduction to the package API and workflow.
4624

47-
### Getting Started
48-
49-
Read the ["Getting Started" guide][getting-started] for a high-level introduction to the package API and workflow.
50-
A minimal working RPC example can be found
51-
[here](docs/Getting-Started.md#remote-calls-using-interfaces).
52-
53-
Browse rest of the [Wiki](https://github.com/capnproto/go-capnproto2/wiki) for in depth explanations of concepts, migration guides, and tutorials.
54-
55-
### Help and Support
25+
## Help and Support
5626

5727
You can find us on Matrix: [Go Cap'n Proto](https://matrix.to/#/!pLcnVUHHRZrUPscloW:matrix.org?via=matrix.org)
5828

59-
### API Reference
29+
## API Reference
6030

61-
Available on [GoDoc](http://pkg.go.dev/capnproto.org/go/capnp/v3).
31+
Available on [pkg.go.dev][godoc]
6232

6333
## API Compatibility
6434

@@ -74,11 +44,11 @@ An exception to this rule is currently in place for the `pogs` package, which is
7444

7545
Note also we may merge breaking changes to the `main` branch without notice. Users are encouraged to pin their dependencies to a major version, e.g. using the semver-aware features of `go get`.
7646

77-
[gocompat]: https://golang.org/doc/go1compat
7847
## License
7948

8049
MIT - see [LICENSE][] file
8150

51+
[godoc]: http://pkg.go.dev/capnproto.org/go/capnp/v3
52+
[gocompat]: https://golang.org/doc/go1compat
8253
[LICENSE]: https://github.com/capnproto/go-capnproto2/blob/master/LICENSE
83-
8454
[getting-started]: docs/Getting-Started.md

0 commit comments

Comments
 (0)