From 51396982891c136007ab08a7f29dca96df92271e Mon Sep 17 00:00:00 2001 From: Zoey de Souza Pessanha Date: Thu, 5 Sep 2024 16:18:56 -0300 Subject: [PATCH 1/2] Update README.md --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index f53a73b..96d5dcb 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,27 @@ def deps do end ``` +### General usage + +This library per si is the base foundation to user Supabase services from Elixir, so to integrate with specific services you need to add each client library you want to use. + +Available client services are: +- [PostgREST](https://github.com/zoedsoupe/postgres-ex) +- [Storage](https://github.com/zoedsoupe/storage-ex) +- [Auth/GoTrue](https://github.com/zoedsoupe/gotrue-ex) + +So if you wanna use the Storage and Auth/GoTrue services, your `mix.exs` should look like that: + +```elixir +def deps do + [ + {:supabase_potion, "~> 0.4"}, # base SDK + {:supabase_storage, "~> 0.3"}, # storage integration + {:supabase_gotrue, "~> 0.3"}, # auth integration + ] +end +``` + ### Clients A `Supabase.Client` holds general information about Supabase, that can be used to intereact with any of the children integrations, for example: `Supabase.Storage` or `Supabase.UI`. From 13486fc17d442c22ce1d0827c0007778d92d60a2 Mon Sep 17 00:00:00 2001 From: n1ghtc4t Date: Fri, 13 Sep 2024 23:48:49 +0900 Subject: [PATCH 2/2] * fix configure key, (#42) :supabase -> :supabasse_potion --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 96d5dcb..46ae244 100644 --- a/README.md +++ b/README.md @@ -62,12 +62,12 @@ A `Supabase.Client` holds general information about Supabase, that can be used t ## Configuration -Ensure your Supabase configurations are set: +Ensure your Supabase configurations are set in runtime.exs: ```elixir import Config -config :supabase, +config :supabase_potion, supabase_base_url: System.fetch_env!("SUPABASE_BASE_URL"), supabase_api_key: System.fetch_env!("SUPABASE_API_KEY"), ```