more docs

README.md

@@ -1,13 +1,51 @@
-Ecto Adapter for ClickHouse using [`:ch`](https://github.com/plausible/ch)
+# Ecto ClickHouse Adapter
+
+<!-- [![Hex Package](https://img.shields.io/hexpm/v/chto.svg)](https://hex.pm/packages/chto)
+     [![Hex Docs](https://img.shields.io/badge/hex-docs-blue.svg)](https://hexdocs.pm/chto) -->
+
+Uses [`:ch`](https://github.com/plausible/ch) as driver.
+
+## Installation
+
+```elixir
+defp deps do
+  [
+    {:chto, github: "plausible/chto"}
+  ]
+end
+```
+
+## Usage
+
+<details>
+<summary>Define repo and start <code>DBConnection</code> pool</summary>
+
+```elixir
+defmodule MyApp.Repo do
+  use Ecto.Repo,
+    adapter: Ecto.Adapters.ClickHouse,
+    otp_app: :my_app
+end
+```
+
+```elixir
+config :my_app, ecto_repos: [MyApp.Repo]
+config :my_app, MyApp.Repo,
+  url: "http://username:password@localhost:8123/default"
+```
+
+```elixir
+MyApp.Repo.start_link()
+```
+
+</details>
 
 ```elixir
 ## speedrun
 
 iex> Mix.install([{:chto, github: "plausible/chto"}])
 
-iex> defmodule Repo do
-       use Ecto.Repo, adapter: Ecto.Adapters.ClickHouse, otp_app: :example
-     end
+iex>
 
 iex> import Ecto.Query
 iex> Repo.start_link()