From 4c983e3085209b28328f941de935dc98eb28a967 Mon Sep 17 00:00:00 2001 From: "Paul K." Date: Thu, 23 Oct 2025 13:12:08 -0400 Subject: [PATCH] chore: enhance README.md with frontend implementation details --- README.md | 12 ++++++++++-- pyproject.toml | 2 +- src/authkit_token/__init__.py | 2 +- 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 659db35..763a8be 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![pypi version](https://img.shields.io/pypi/v/authkit-token)](https://pypi.org/project/authkit-token) [![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/) -Secure token generation for [Pica AuthKit](https://docs.picaos.com/authkit) using Python. +Secure token generation for [Pica's AuthKit](https://docs.picaos.com/authkit) using Python. ## Install @@ -52,6 +52,14 @@ You can get your API key from the [Pica dashboard](https://dashboard.picaos.com/ If you pass an `identity` or `identity_type` (`user`, `team`, `organization`, or `project`), you'll be able to query for all connections scoped to that identity. The identity is used to generate the unique Connection Key for the user once they successfully connect an account. +## Frontend Implementation + +To implement the AuthKit component in your frontend, you'll need to use the `@picahq/authkit` package. It's fully compatible with popular frameworks such as React, Next.js, Vue, Svelte, and more. + +- **NPM package**: https://www.npmjs.com/package/@picahq/authkit +- **Documentation**: https://docs.picaos.com/authkit +- **Setup guide**: https://docs.picaos.com/authkit/setup + ## Diagram ```mermaid @@ -77,7 +85,7 @@ sequenceDiagram ## Full Documentation -Please refer to the official [Pica AuthKit](https://docs.picaos.com/authkit) docs for a more holistic understanding of Pica AuthKit. +Please refer to the official [Pica AuthKit](https://docs.picaos.com/authkit) docs for a more holistic understanding of AuthKit. ## License diff --git a/pyproject.toml b/pyproject.toml index b532e1d..34cd92b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "authkit-token" -version = "1.0.0" +version = "1.0.1" description = "Secure token generation for Pica AuthKit" readme = "README.md" requires-python = ">=3.9" diff --git a/src/authkit_token/__init__.py b/src/authkit_token/__init__.py index 78417f8..1ec4614 100644 --- a/src/authkit_token/__init__.py +++ b/src/authkit_token/__init__.py @@ -26,7 +26,7 @@ IdentityType, ) -__version__ = "1.0.0" +__version__ = "1.0.1" __all__ = [ "AuthKitToken",