diff --git a/protobuf/AUTHORS b/AUTHORS similarity index 100% rename from protobuf/AUTHORS rename to AUTHORS diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..7efe25f9e --- /dev/null +++ b/LICENSE @@ -0,0 +1,27 @@ +Copyright 2013, the Dart project authors. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + * Neither the name of Google LLC nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index 32f9b8c2f..0fd4d8d4d 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@ -# Protobuf support for Dart - [![CI status](https://github.com/google/protobuf.dart/workflows/Dart%20CI/badge.svg)](https://github.com/google/protobuf.dart/actions?query=workflow%3A%22Dart%22+branch%3Amaster) -[![pub package](https://img.shields.io/pub/v/protobuf.svg)](https://pub.dev/packages/protobuf) + +## Protobuf support for Dart [Protocol Buffers](https://developers.google.com/protocol-buffers) (protobuf) are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data. -This repository is home to packages related to [protobuf for Dart](https://pub.dev/documentation/protobuf/latest/). -It contains: +This repository is home to packages related to +[protobuf for Dart](https://pub.dev/documentation/protobuf/latest/). - - [protoc_plugin](protoc_plugin/) A Dart back-end for the protoc compiler. - - [protobuf](protobuf/) Support library for the generated code. +Package | Description | Published Version +--- | --- | --- +[protobuf](protobuf/) | A support library for the generated code | [![pub package](https://img.shields.io/pub/v/protobuf.svg)](https://pub.dev/packages/protobuf) +[protoc_plugin](protoc_plugin/) | A Dart back-end for the protoc compiler | [![pub package](https://img.shields.io/pub/v/protoc_plugin.svg)](https://pub.dev/packages/protoc_plugin) +[api_benchmark](api_benchmark/) | Benchmarking for various API calls | +[query_benchmark](query_benchmark/) | Benchmark for encoding and decoding of a "real-world" protobuf | diff --git a/protobuf/CONTRIBUTING.md b/protobuf/CONTRIBUTING.md deleted file mode 100644 index 8dab68d05..000000000 --- a/protobuf/CONTRIBUTING.md +++ /dev/null @@ -1,10 +0,0 @@ -# How to contribute - -### Sign our Contributor License Agreement (CLA) - -Even for small changes, we ask that you please sign the CLA electronically -[here](https://developers.google.com/open-source/cla/individual). -The CLA is necessary because you own the copyright to your changes, even -after your contribution becomes part of our codebase, so we need your permission -to use and distribute your code. You can find more details -[here](https://code.google.com/p/dart/wiki/Contributing). diff --git a/protobuf/README.md b/protobuf/README.md index 0bba861f3..f097e29a3 100644 --- a/protobuf/README.md +++ b/protobuf/README.md @@ -1,4 +1,5 @@ [![pub package](https://img.shields.io/pub/v/protobuf.svg)](https://pub.dev/packages/protobuf) +[![package publisher](https://img.shields.io/pub/publisher/protobuf.svg)](https://pub.dev/packages/protobuf/publisher) Provides runtime support for a Dart implementation of [protobufs][1]. diff --git a/protoc_plugin/AUTHORS b/protoc_plugin/AUTHORS deleted file mode 100644 index 7c12ae681..000000000 --- a/protoc_plugin/AUTHORS +++ /dev/null @@ -1,6 +0,0 @@ -# Below is a list of people and organizations that have contributed -# to the Dart project. Names should be added to the list like so: -# -# Name/Organization - -Google Inc. diff --git a/protoc_plugin/README.md b/protoc_plugin/README.md index ca5c3a242..9351998fe 100644 --- a/protoc_plugin/README.md +++ b/protoc_plugin/README.md @@ -1,8 +1,7 @@ -# Dart plugin for the protoc compiler - [![pub package](https://img.shields.io/pub/v/protoc_plugin.svg)](https://pub.dev/packages/protoc_plugin) +[![package publisher](https://img.shields.io/pub/publisher/protoc_plugin.svg)](https://pub.dev/packages/protoc_plugin/publisher) -This repository provides a plugin for the [protoc compiler][1]. It generates +This repository provides a Dart plugin for the [protoc compiler][1]. It generates Dart files for working with data in protocol buffers format. [1]: https://developers.google.com/protocol-buffers/docs/cpptutorial#compiling-your-protocol-buffers