Skip to content

Commit

Permalink
Refactor file locations, update READMEs (google#657)
Browse files Browse the repository at this point in the history
  • Loading branch information
devoncarew authored May 20, 2022
1 parent a92abc5 commit 0419af7
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 26 deletions.
File renamed without changes.
27 changes: 27 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 |
10 changes: 0 additions & 10 deletions protobuf/CONTRIBUTING.md

This file was deleted.

1 change: 1 addition & 0 deletions protobuf/README.md
Original file line number Diff line number Diff line change
@@ -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].

Expand Down
6 changes: 0 additions & 6 deletions protoc_plugin/AUTHORS

This file was deleted.

5 changes: 2 additions & 3 deletions protoc_plugin/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 0419af7

Please sign in to comment.