From c17bc78ceb91f0b57beee2532c615b061a14849a Mon Sep 17 00:00:00 2001 From: Carlos Souza Date: Fri, 16 Aug 2024 10:12:31 -0400 Subject: [PATCH] Bump version and update docs --- CHANGELOG.md | 8 +++++--- README.md | 12 ++++++++---- lib/xogmios/mempool_txs.ex | 2 +- mix.exs | 2 +- 4 files changed, 15 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2df52e8..c5f5a59 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,10 +5,12 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] +## [v0.5.0](https://github.com/wowica/xogmios/releases/tag/v0.5.0) (2024-08-16) -- Added partial support for Mempool monitoring mini-protocol. Allows reading transactions in the mempool. -- Added generators mix task for generating boilerplate code for client modules: `mix help xogmios.gen.client` +### Added + +- Initial support for Mempool monitoring mini-protocol. Allows reading transactions from the mempool. +- mix task for generating boilerplate code for client modules. See `mix help xogmios.gen.client` ## [v0.4.1](https://github.com/wowica/xogmios/releases/tag/v0.4.1) (2024-06-05) diff --git a/README.md b/README.md index 01cef8b..591e7b0 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Add the dependency to `mix.exs`: ```elixir defp deps do [ - {:xogmios, ">= 0.0.1"} + {:xogmios, ">= 0.0.0"} ] end ``` @@ -41,12 +41,16 @@ The mix task `xogmios.gen.client` is available to help generate the necessary client code for each of the supported mini-protocols. Information on usage can be found by running the following mix task: -`mix help xogmios.gen.client`. +```bash +mix help xogmios.gen.client +``` -For example, the following mix command generates a client module for the +For example, the following mix task generates a client module for the ChainSync mini-protocol: -`mix xogmios.gen.client -p chain_sync ChainSyncClient` +```bash +mix xogmios.gen.client -p chain_sync ChainSyncClient +``` A new file should be created at _./lib/my_app/chain_sync_client.ex_ diff --git a/lib/xogmios/mempool_txs.ex b/lib/xogmios/mempool_txs.ex index 23def24..fac0618 100644 --- a/lib/xogmios/mempool_txs.ex +++ b/lib/xogmios/mempool_txs.ex @@ -72,7 +72,7 @@ defmodule Xogmios.MempoolTxs do @doc """ Starts a new Mempool process linked to the current process. - This function should not be called directly, but rather via `Xogmios.start_mempool_link/2` + This function should not be called directly, but rather via `Xogmios.start_mempool_txs_link/2` """ @spec start_link(module(), start_options :: Keyword.t()) :: {:ok, pid()} | {:error, term()} def start_link(client, opts) do diff --git a/mix.exs b/mix.exs index 5ac71e2..68bf454 100644 --- a/mix.exs +++ b/mix.exs @@ -3,7 +3,7 @@ defmodule Xogmios.MixProject do @description "An Elixir client for Ogmios" @source_url "https://github.com/wowica/xogmios" - @version "0.4.1" + @version "0.5.0" def project do [