Skip to content
This repository was archived by the owner on Aug 5, 2026. It is now read-only.

Commit 609c301

Browse files
adevinwildclaude
andauthored
docs: improve README with badges (#44)
- Add npm version, downloads, license badges - Add Node.js and TypeScript badges - Add installation section - Reorganize links Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent c199626 commit 609c301

1 file changed

Lines changed: 26 additions & 3 deletions

File tree

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,42 @@
1111
@perseidesjs/auth-otp
1212
</h1>
1313

14+
<p align="center">
15+
<a href="https://www.npmjs.com/package/@perseidesjs/auth-otp"><img src="https://img.shields.io/npm/v/@perseidesjs/auth-otp.svg" alt="npm version"></a>
16+
<a href="https://www.npmjs.com/package/@perseidesjs/auth-otp"><img src="https://img.shields.io/npm/dm/@perseidesjs/auth-otp.svg" alt="npm downloads"></a>
17+
<a href="https://github.com/perseidesjs/auth-otp/blob/develop/LICENSE.md"><img src="https://img.shields.io/npm/l/@perseidesjs/auth-otp.svg" alt="license"></a>
18+
<img src="https://img.shields.io/badge/node-%3E%3D20-brightgreen" alt="node version">
19+
<img src="https://img.shields.io/badge/TypeScript-5.x-blue" alt="typescript">
20+
</p>
21+
1422
<h4 align="center">
1523
<a href="https://perseides.org">Website</a> |
24+
<a href="https://docs.perseides.org/plugins/auth-otp/getting-started">Documentation</a> |
1625
<a href="https://www.medusajs.com">Medusa</a>
1726
</h4>
1827

1928
<p align="center">
20-
Implement seamlessly OTP-based authentication for Medusa 2.x
29+
Implement seamlessly OTP-based authentication for Medusa 2.x
2130
</p>
2231

2332
<p align="center">
2433
<img src="./.github/assets/preview.gif" alt="Preview of @perseidesjs/auth-otp in action">
2534
</p>
2635

36+
## Installation
37+
38+
```bash
39+
npm install @perseidesjs/auth-otp
40+
# or
41+
yarn add @perseidesjs/auth-otp
42+
# or
43+
pnpm add @perseidesjs/auth-otp
44+
```
45+
46+
## Documentation
47+
48+
Access the full documentation at [docs.perseides.org/plugins/auth-otp](https://docs.perseides.org/plugins/auth-otp/getting-started)
49+
50+
## License
2751

28-
# [Documentation](https://docs.perseides.org/plugins/auth-otp/getting-started)
29-
Access the documentation for the package, by clicking ["here"](https://docs.perseides.org/plugins/auth-otp/getting-started)
52+
MIT

0 commit comments

Comments
 (0)