From a0a0d79d4e1608dce31093b69eed48fd8bd664f8 Mon Sep 17 00:00:00 2001 From: "joel@joellee.org" Date: Thu, 1 Jun 2023 18:47:37 +0800 Subject: [PATCH] feat: update README --- README.md | 7 ++----- pyproject.toml | 2 +- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index faaef48c..ec0c4dfe 100644 --- a/README.md +++ b/README.md @@ -55,13 +55,13 @@ Also, the `gotrue` library for Python parses the date-time string into `datetime To instantiate the client, you'll need the URL and any request headers at a minimum. ```python -from gotrue import Client +from gotrue import SyncGoTrueClient headers = { "apiKey": "my-mega-awesome-api-key", # ... any other headers you might need. } -client: Client = Client(url="www.genericauthwebsite.com", headers=headers) +client: SyncGoTrueClient = SyncGoTrueClient(url="www.genericauthwebsite.com", headers=headers) ``` To send a magic email link to the user, just provide the email kwarg to the `sign_in` method: @@ -96,6 +96,3 @@ assert client.session() is not None ## Contributions We would be immensely grateful for any contributions to this project. In particular are the following items: - -- Add documentation -- Update `README.md` diff --git a/pyproject.toml b/pyproject.toml index 06c827c9..e101214b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "gotrue" -version = "1.0.1" +version = "1.0.2" description = "Python Client Library for GoTrue" authors = ["Joel Lee "] homepage = "https://github.com/supabase-community/gotrue-py"