From d310d417e4afd3bf4e03a62d31e5a8f573962ae2 Mon Sep 17 00:00:00 2001 From: Ryan Michela Date: Fri, 18 Jun 2021 13:50:10 -0400 Subject: [PATCH] Fix readme --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9568583..81b94bd 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Protolock Version: [20210218T172155Z](https://github.com/nilslice/protolock/rele # Protobuf Backwards Compatibility Check Maven Plugin -The proto-backwards-compatibility plugin is a Maven plugin to +The `proto-backwards-compatibility` plugin is a Maven plugin to run a backwards compatibility check on a set of protobuf IDL files. The plugin can be integrated into various phases of a maven build to check that any changes to a set of .proto files are backwards compatible. This ensures that these changes do @@ -14,7 +14,8 @@ track of the state of the .proto files. This file is updated when a non-breaking is made, and should be checked in along with any other changes. It is also possible to force any breaking changes and reset the current state -by either +by either + * deleting the proto.lock file. It will then reinitialize the next time the plugin is run. * or by specifying parameter property `acceptBreakingChanges` (`-DacceptBreakingChanges=true`) @@ -26,7 +27,7 @@ https://developers.google.com/protocol-buffers/docs/proto#backwards-compatibilit ## Usage -The os-maven-plugin extension (https://github.com/trustin/os-maven-plugin) +The `os-maven-plugin` extension (https://github.com/trustin/os-maven-plugin) must be added to your project's pom.xml file in order for this plugin to work. ```xml