Skip to content

revelrylabs/elixir-stellar-client

Repository files navigation

Stellar

Build Status Coverage Status Hex.pm License: MIT

A Stellar client for Elixir.

Documentation

Installation

The package can be installed by adding stellar to your list of dependencies in mix.exs:

def deps do
  [
    {:stellar, "~> 0.3.0"}
  ]
end

Add the following to your configuration:

config :stellar, network: :public # Default is `:public`. To use test network, use `:test`
config :stellar, hackney_options: [] # Options to pass to Hackney

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/stellar.

Contributing and Development

Bug reports and pull requests are welcomed. See CONTRIBUTING.md for development guidance.

Everyone is welcome to participate in the project. We expect contributors to adhere the Contributor Covenant Code of Conduct (see CODE_OF_CONDUCT.md).