Skip to content
This repository has been archived by the owner on Jan 26, 2021. It is now read-only.

Commit

Permalink
Merge pull request #83 from dart-lang/mit-mit-badges
Browse files Browse the repository at this point in the history
Add badges
  • Loading branch information
mit-mit authored Jul 5, 2017
2 parents 818ccd0 + 03b1fa6 commit 2467861
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,27 @@
Protoc compiler Dart plugin
===========================
# Dart plugin for the protoc compiler

This repository provides a plugin for the [protoc compiler](https://developers.google.com/protocol-buffers/docs/cpptutorial#compiling-your-protocol-buffers).
[![Build Status](https://travis-ci.org/dart-lang/dart-protoc-plugin.svg?branch=master)](https://travis-ci.org/dart-lang/dart-protoc-plugin)
[![pub package](https://img.shields.io/pub/v/protoc_plugin.svg)](https://pub.dartlang.org/packages/protoc_plugin)

This repository provides a plugin for the [protoc
compiler](https://developers.google.com/protocol-buffers/docs/cpptutorial#compiling-your-protocol-buffers).
It generates Dart files for working with data in protocol buffers format. At
this time we only support [proto2](https://developers.google.com/protocol-buffers/docs/proto), but proto3 may work
in simple cases due to backwards compatibility.
this time we only support
[proto2](https://developers.google.com/protocol-buffers/docs/proto), but proto3
may work in simple cases due to backwards compatibility.

Requirements
------------

To compile a .proto file, you must use the 'protoc' command which is
[installed separately](https://developers.google.com/protocol-buffers/docs/downloads).
To compile a .proto file, you must use the 'protoc' command which is [installed
separately](https://developers.google.com/protocol-buffers/docs/downloads).
Protobuf 3.0.0 or above is required.

The generated files are pure Dart code that run in either in the Dart VM or in a
browser (using dart2js). They depend the [protobuf Dart package](https://pub.dartlang.org/packages/protobuf). A Dart project that includes
generated files should add "protobuf" to its pubspec.yaml file.
browser (using dart2js). They depend the [protobuf Dart
package](https://pub.dartlang.org/packages/protobuf). A Dart project that
includes generated files should add "protobuf" to its pubspec.yaml file.


How to build and use
--------------------
Expand Down

0 comments on commit 2467861

Please sign in to comment.