Skip to content

Commit 2928189

Browse files
authored
Merge pull request #1 from picahq/chore/readme-update
chore: enhance README.md with frontend implementation details
2 parents 697d99b + 4c983e3 commit 2928189

File tree

3 files changed

+12
-4
lines changed

3 files changed

+12
-4
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![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/)
44

5-
Secure token generation for [Pica AuthKit](https://docs.picaos.com/authkit) using Python.
5+
Secure token generation for [Pica's AuthKit](https://docs.picaos.com/authkit) using Python.
66

77
## Install
88

@@ -52,6 +52,14 @@ You can get your API key from the [Pica dashboard](https://dashboard.picaos.com/
5252

5353
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.
5454

55+
## Frontend Implementation
56+
57+
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.
58+
59+
- **NPM package**: https://www.npmjs.com/package/@picahq/authkit
60+
- **Documentation**: https://docs.picaos.com/authkit
61+
- **Setup guide**: https://docs.picaos.com/authkit/setup
62+
5563
## Diagram
5664

5765
```mermaid
@@ -77,7 +85,7 @@ sequenceDiagram
7785

7886
## Full Documentation
7987

80-
Please refer to the official [Pica AuthKit](https://docs.picaos.com/authkit) docs for a more holistic understanding of Pica AuthKit.
88+
Please refer to the official [Pica AuthKit](https://docs.picaos.com/authkit) docs for a more holistic understanding of AuthKit.
8189

8290
## License
8391

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "authkit-token"
7-
version = "1.0.0"
7+
version = "1.0.1"
88
description = "Secure token generation for Pica AuthKit"
99
readme = "README.md"
1010
requires-python = ">=3.9"

src/authkit_token/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
IdentityType,
2727
)
2828

29-
__version__ = "1.0.0"
29+
__version__ = "1.0.1"
3030

3131
__all__ = [
3232
"AuthKitToken",

0 commit comments

Comments
 (0)