Skip to content

Commit

Permalink
1.6
Browse files Browse the repository at this point in the history
  • Loading branch information
ahamez committed Oct 7, 2021
1 parent 17178bc commit c535945
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 6 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@

![Elixir CI](https://github.com/ahamez/protox/workflows/Elixir%20CI/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/ahamez/protox/badge.svg?branch=master)](https://coveralls.io/github/ahamez/protox?branch=master) [![Hex Docs](https://img.shields.io/badge/hex-docs-brightgreen.svg)](https://hexdocs.pm/protox/) [![Hex.pm Version](http://img.shields.io/hexpm/v/protox.svg)](https://hex.pm/packages/protox) [![License](https://img.shields.io/hexpm/l/protox.svg)](https://github.com/ahamez/protox/blob/master/LICENSE)

> **This README is for the current development version, which is not the currently published version [1.5.1](https://hex.pm/packages/protox)**. You can find the
docs for the latest published version of `protox` [here](https://hexdocs.pm/protox/readme.html).

`protox` is an Elixir library to work with [Google's Protocol Buffers](https://developers.google.com/protocol-buffers), versions 2 and 3. It supports both binary and JSON encoding and decoding ([well-known types](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf) included, except the Any type for the time being).

The primary objective of `protox` is **reliability**: it uses [property based testing](https://github.com/alfert/propcheck) and has a [near 100% code coverage](https://coveralls.io/github/ahamez/protox?branch=master). Also, using [mutation testing](https://en.wikipedia.org/wiki/Mutation_testing) with the invaluable help of [Muzak pro](https://devonestes.com/muzak), the quality of the `protox` test suite has been validated. Therefore, `protox` [passes all the tests](#conformance) of the conformance checker provided by Google.
Expand Down Expand Up @@ -69,7 +66,7 @@ Add `:protox` to your list of dependencies in `mix.exs`:

```elixir
def deps do
[{:protox, "~> 1.5"}]
[{:protox, "~> 1.6"}]
end
```

Expand All @@ -78,7 +75,7 @@ If you plan to use the JSON encoding, you'll need to add [`Jason`](https://githu
```elixir
def deps do
[
{:protox, "~> 1.5"},
{:protox, "~> 1.6"},
{:jason, "~> 1.2"}
]
end
Expand Down
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ defmodule Protox.Mixfile do
def project do
[
app: :protox,
version: "1.6.0-dev",
version: "1.6.0",
elixir: "~> 1.7",
build_embedded: Mix.env() == :prod,
start_permanent: Mix.env() == :prod,
Expand Down

0 comments on commit c535945

Please sign in to comment.