Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump version and update docs #39

Merged
merged 1 commit into from
Aug 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Add the dependency to `mix.exs`:
```elixir
defp deps do
[
{:xogmios, ">= 0.0.1"}
{:xogmios, ">= 0.0.0"}
]
end
```
Expand All @@ -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_

Expand Down
2 changes: 1 addition & 1 deletion lib/xogmios/mempool_txs.ex
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -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
[
Expand Down
Loading