Skip to content

Commit a5245ec

Browse files
authored
Update README.md
1 parent 151e261 commit a5245ec

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# A Java Library to Serialize Protocol Buffer Files
2-
[![Build Status](https://travis-ci.com/stefan-ka/protobufgen.svg?branch=master)](https://travis-ci.com/stefan-ka/protobufgen) [![codecov](https://codecov.io/gh/stefan-ka/protobufgen/branch/master/graph/badge.svg)](https://codecov.io/gh/stefan-ka/protobufgen) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
2+
[![Build Status](https://travis-ci.com/stefan-ka/protobufgen.svg?branch=master)](https://travis-ci.com/stefan-ka/protobufgen) [![codecov](https://codecov.io/gh/stefan-ka/protobufgen/branch/master/graph/badge.svg)](https://codecov.io/gh/stefan-ka/protobufgen) [![Maven Central](https://img.shields.io/maven-central/v/io.github.stefan-ka/protobufgen.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.github.stefan-ka%22%20AND%20a:%22protobufgen%22) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
33

44
This is a simple Java library containing a [protocol buffer](https://developers.google.com/protocol-buffers) model and serializer. It can be used in case you want to generate [\*.proto files](https://developers.google.com/protocol-buffers/docs/proto3) within a Java application. We currently support [proto3](https://developers.google.com/protocol-buffers/docs/proto3) only.
55

@@ -72,6 +72,23 @@ service SampleService {
7272
```
7373
Nesting messages is not supported yet.
7474

75+
### Publication
76+
The library is published to Maven central. Thus, you can easily use it in your project with Gradle or Maven:
77+
78+
**Gradle:**
79+
```gradle
80+
implementation 'io.github.stefan-ka:protobufgen:1.0.0'
81+
```
82+
83+
**Maven:**
84+
```xml
85+
<dependency>
86+
<groupId>io.github.stefan-ka</groupId>
87+
<artifactId>protobufgen</artifactId>
88+
<version>1.0.0</version>
89+
</dependency>
90+
```
91+
7592
## Contributing
7693
Contribution is always welcome! Create an issue if you just want to report a bug or missing feature. In case you want to implement a change/bugfix by yourself, follow these steps:
7794

0 commit comments

Comments
 (0)