README.md

# ExSui

An Elixir library to interface with the Sui blockchain using gRPC. This library is an alpha version.


## Getting Started

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `ex_sui` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:ex_sui, "~> 0.1.0"}
  ]
end
```


## Contributing

[Download](https://github.com/protocolbuffers/protobuf?tab=readme-ov-file#protobuf-compiler-installation) and install the protocol buffer compiler (protoc).

MacOS users can install it through Homebrew by running the following command: 
```
brew install protobuf
```
Other platforms e.g. windows, linux can be installed by following the steps [here](https://github.com/protocolbuffers/protobuf?tab=readme-ov-file#protobuf-compiler-installation).

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at <https://hexdocs.pm/ex_sui>.