Skip to content

chore: enhance README.md with frontend implementation details #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 23, 2025
Merged

chore: enhance README.md with frontend implementation details #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion src/authkit_token/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
IdentityType,
)

__version__ = "1.0.0"
__version__ = "1.0.1"

__all__ = [
"AuthKitToken",
Expand Down