Prepare for hex.pm publication

Author: andrzej-mag

docs/README.md

@@ -4,9 +4,12 @@ Service mesh support for Elixir.
 `Meshx` is released as group of separate Elixir packages, summary for each package is provided below.
 
 ### MeshxConsul
-`MeshxConsul` is a service mesh adapter implementing `Meshx.ServiceMesh` behaviour using HashiCorp [Consul](https://www.consul.io/) as external service mesh solution. Package is used to manage mesh service and upstream endpoints, consumed by user service providers and upstream clients.
+[![Hex Version](https://img.shields.io/hexpm/v/meshx_consul)](https://hex.pm/packages/meshx_consul)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen)](https://hexdocs.pm/meshx_consul)
 
-`MeshxConsul` using external dependencies (Consul as control plane and Envoy/other as data plane), complements user client/server applications with powerful service mesh features:
+`MeshxConsul` is a service mesh adapter implementing `Meshx.ServiceMesh` behaviour using HashiCorp [Consul](https://www.consul.io/) as an external service mesh solution. Package manages mesh service and upstream endpoints, which are later consumed by user service providers and upstream clients.
+
+`MeshxConsul` by using external dependencies, Consul as control plane and Envoy/other proxy as data plane, complements user client/server applications with powerful service mesh features:
 * [mTLS](https://www.consul.io/docs/connect/connect-internals#mutual-transport-layer-security-mtls) connections,
 * service-to-service permissions: [intentions](https://www.consul.io/docs/connect/intentions),
 * mesh service [health checks](https://www.consul.io/docs/discovery/checks),
@@ -18,20 +21,22 @@ Service mesh support for Elixir.
   * `MeshxRpc` - RPC (Remote Procedure Call) functionality,
   * `MeshxNode` - service mesh distribution module.
 
-**MeshxConsul**: [[github](https://github.com/andrzej-mag/meshx_consul/)].
-
 ### MeshxRpc
-`MeshxRpc` can be considered as alternative to Erlang OTP [`:erpc`](https://erlang.org/doc/man/erpc.html) (or [`:rpc`](https://erlang.org/doc/man/rpc.html)) modules. `MeshxRpc` restricts request execution scope to single RPC server module to improve operational node security. `MeshxRpc` provides built-in features crucial for binary data transfers: chunking user data into smaller blocks to avoid IO socket blocking and transmission error detection with user configurable asynchronously executed block checksum functions.
+[![Hex Version](https://img.shields.io/hexpm/v/meshx_rpc)](https://hex.pm/packages/meshx_rpc)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen)](https://hexdocs.pm/meshx_rpc)
+
+`MeshxRpc` can be considered as alternative to Erlang OTP [`:erpc`](https://erlang.org/doc/man/erpc.html) (or [`:rpc`](https://erlang.org/doc/man/rpc.html)) module. `MeshxRpc` restricts request execution scope to single RPC server module to improve operational node security. `MeshxRpc` provides built-in features crucial for binary data transfers: chunking user data into smaller blocks to avoid IO socket blocking and transmission error detection with user configurable asynchronously executed block checksum functions.
 
 `MeshxRpc` is using custom binary communication protocol, hence it doesn't depend on Erlang distribution protocol. `MeshxRpc` fits best in cases where user application requires execution of plain remote functions and doesn't require remote process management features like process linking or monitoring available only for natively distributed nodes. `MeshxRpc` can be used with nodes connected with Erlang distribution if justified by package additional features, otherwise OTP `:erpc` should be used.
 
 `MeshxRpc` primary objective is to work paired with service mesh adapter (`MeshxConsul`) as a user mesh service, however it can be used with any other data transport solution, eg. ssh port forwarding or VPN. For special use cases it can work standalone: `MeshxRpc` server and client running on the same host and sharing common connection socket.
 
-`MeshxRpc` designed to work primarily as mesh service doesn't offer data encryption or any access control mechanisms as those are natively provided by service mesh environment.
-
-**MeshxRpc**: [[github](https://github.com/andrzej-mag/meshx_rpc/)].
+`MeshxRpc` doesn't offer data encryption, authorization or authentication mechanisms as those are natively provided by service mesh environment.
 
 ### MeshxNode
+[![Hex Version](https://img.shields.io/hexpm/v/meshx_node)](https://hex.pm/packages/meshx_node)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen)](https://hexdocs.pm/meshx_node)
+
 `MeshxNode` delivers Erlang style nodes connectivity by registering  special "node service" using service mesh adapter. Communication between nodes is realized using service mesh sidecar proxies and upstreams. Data traffic is secured with mTLS, managed by service mesh application control plane (e.g. Consul).
 
 MeshxNode can be considered as alternative to Erlang Port Mapper Daemon ([EPMD](https://erlang.org/doc/man/epmd.html)) and distribution module (usually [`:inet_tls_dist`](http://erlang.org/doc/apps/ssl/ssl_distribution.html) or `:inet_dist`).
@@ -40,11 +45,10 @@ MeshxNode can be considered as alternative to Erlang Port Mapper Daemon ([EPMD](
 
 Users are free to use any mesh service management features provided by external mesh application or L4 proxy software. Consul service intentions, tokens or ACLs to manage "node service" access permissions might be an interesting feature to consider here.
 
-**MeshxNode**: [[github](https://github.com/andrzej-mag/meshx_node/)].
-
 ### Meshx
-`Meshx` package doesn't offer any end-user functionality. `Meshx` should be used by developers building new service mesh adapters implementing `Meshx.ServiceMesh` behavior.
+[![Hex Version](https://img.shields.io/hexpm/v/meshx)](https://hex.pm/packages/meshx)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen)](https://hexdocs.pm/meshx)
 
-Service mesh adapter in practice should be reasonably thin layer between user application using `Meshx` packages and external software providing service mesh solution. Mesh adapter should use 3rd party application API to implement functionality required by `Meshx.ServiceMesh` behavior. As described earlier `Meshx` is released with HashiCorp Consul adapter - `MeshxConsul`.
+`Meshx` package doesn't offer any end-user functionality. `Meshx` should be used by developers building new service mesh adapters implementing `Meshx.ServiceMesh` behavior.
 
-**Meshx**: [[github](https://github.com/andrzej-mag/meshx/)].
+Service mesh adapter in practice should be reasonably thin layer between user application using `Meshx` packages and external software providing service mesh solution. Mesh adapter should use third party application API to implement functionality required by `Meshx.ServiceMesh` behavior. As described earlier `Meshx` is released with HashiCorp Consul adapter - `MeshxConsul`.

mix.exs

@@ -1,8 +1,8 @@
 defmodule Meshx.MixProject do
   use Mix.Project
 
-  @version "0.1.0-dev"
   @source_url "https://github.com/andrzej-mag/meshx"
+  @version "0.1.0"
 
   def project do
     [
@@ -36,7 +36,12 @@ defmodule Meshx.MixProject do
       main: "readme",
       source_url: @source_url,
       source_ref: "v#{@version}",
-      extras: ["docs/README.md"]
+      extras: ["docs/README.md"],
+      deps: [
+        meshx_consul: "https://hexdocs.pm/meshx_consul",
+        meshx_node: "https://hexdocs.pm/meshx_node",
+        meshx_rpc: "https://hexdocs.pm/meshx_rpc"
+      ]
     ]
   end
 end