Skip to content

Commit

Permalink
Add feedback from Lars Wirzenius
Browse files Browse the repository at this point in the history
  • Loading branch information
timostamm committed Apr 21, 2021
1 parent 1fd9d7c commit 16ce40d
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 12 deletions.
12 changes: 5 additions & 7 deletions MANUAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,11 @@ protobuf-ts manual

## What are protocol buffers

Protocol buffers are a definition language for simple data structures
that can be efficiently serialized.

Using the protocol buffer compiler (`protoc`) you can "compile" a
`.proto` file to many languages.

To learn more about the protocol buffer language, please check the
Protocol buffers is an [interface definition language](https://en.wikipedia.org/wiki/Interface_description_language)
and binary serialization format.
Data structures defined in `.proto` files are platform-independent and can
be used in many languages.
To learn more about the capabilities, please check the
official [language guide](https://developers.google.com/protocol-buffers/docs/overview).


Expand Down
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@ protobuf-ts [![<timostamm>](https://circleci.com/gh/timostamm/protobuf-ts.svg?st
===========


Protocol buffers and RPC for Node.js and the Web Browser. Pure TypeScript.
[Protocol buffers](https://developers.google.com/protocol-buffers)
and [RPC](https://en.wikipedia.org/wiki/Remote_procedure_call)
for Node.js and the Web Browser.
Pure TypeScript.

For the following `.proto` file:
```proto
Expand Down Expand Up @@ -32,6 +35,15 @@ pete = Person.fromBinary(bytes);
pete = Person.fromJsonString('{"name":"pete", "id":"123", "years": 30}')
```

### What are protocol buffers?

Protocol buffers is an [interface definition language](https://en.wikipedia.org/wiki/Interface_description_language)
and binary serialization format.
Data structures defined in `.proto` files are platform-independent and can
be used in many languages.
To learn more about the capabilities, please check the
official [language guide](https://developers.google.com/protocol-buffers/docs/overview).


### Quickstart

Expand Down Expand Up @@ -73,8 +85,8 @@ Read the [MANUAL](MANUAL.md) to learn more.

### Copyright

- The [algorithm to decode UTF8](./packages/runtime/src/protobufjs-utf8.ts) is Copyright 2016 by Daniel Wirtz, licensed under BSD-3-Clause.
- The [algorithm to encode and decode varint](./packages/runtime/src/goog-varint.ts) is Copyright 2008 Google Inc., licensed under BSD-3-Clause.
- The [code to decode UTF8](./packages/runtime/src/protobufjs-utf8.ts) is Copyright 2016 by Daniel Wirtz, licensed under BSD-3-Clause.
- The [code to encode and decode varint](./packages/runtime/src/goog-varint.ts) is Copyright 2008 Google Inc., licensed under BSD-3-Clause.
- The files [plugin.ts](./packages/plugin-framework/src/google/protobuf/compiler/plugin.ts) and [descriptor.ts](./packages/plugin-framework/src/google/protobuf/descriptor.ts) are Copyright 2008 Google Inc., licensed under BSD-3-Clause
- The [gRPC status codes](./packages/grpcweb-transport/src/goog-grpc-status-code.ts) are Copyright 2016 gRPC authors, licensed under Apache-2.0.
- The [Twirp error codes](./packages/twirp-transport/src/twitch-twirp-error-code.ts) are Copyright 2018 Twitch Interactive, Inc., licensed under Apache-2.0.
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ or check the repository [README](https://github.com/timostamm/protobuf-ts/README

### Copyright

- The [algorithm to decode UTF8](https://github.com/timostamm/protobuf-ts/blob/master/packages/runtime/src/protobufjs-utf8.ts) is Copyright 2016 by Daniel Wirtz, licensed under BSD-3-Clause.
- The [algorithm to encode and decode varint](https://github.com/timostamm/protobuf-ts/blob/master/packages/runtime/src/goog-varint.ts) is Copyright 2008 Google Inc., licensed under BSD-3-Clause.
- The [code to decode UTF8](https://github.com/timostamm/protobuf-ts/blob/master/packages/runtime/src/protobufjs-utf8.ts) is Copyright 2016 by Daniel Wirtz, licensed under BSD-3-Clause.
- The [code to encode and decode varint](https://github.com/timostamm/protobuf-ts/blob/master/packages/runtime/src/goog-varint.ts) is Copyright 2008 Google Inc., licensed under BSD-3-Clause.
- All other files are licensed under Apache-2.0, see [LICENSE](https://github.com/timostamm/protobuf-ts/blob/master/packages/runtime/LICENSE).

0 comments on commit 16ce40d

Please sign in to comment.