Skip to content

Commit 51b7e28

Browse files
docs: update package documentation and readme
1 parent 9a94e18 commit 51b7e28

4 files changed

Lines changed: 11 additions & 5 deletions

File tree

.changeset/shaky-cobras-sit.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"splitwise-ts": patch
3+
"docs": patch
4+
---
5+
6+
Update readme and documentation

README.md

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

33
# Splitwise Typescript
44

5-
A high-performance, fully typed SDK for integrating with Splitwise, designed for maximum speed and flexibility. This SDK is compatible with Web Workers, browsers, and Node.js, ensuring seamless usage across different environments. Built with TypeScript, it offers robust type safety and developer-friendly interfaces, making it the fastest and most reliable way to interact with Splitwise programmatically.
5+
A high-performance, fully typed SDK for integrating with Splitwise, designed for maximum speed and flexibility. This SDK is compatible with Workers and Node.js, ensuring seamless usage across different environments. Built with TypeScript, it offers robust type safety and developer-friendly interfaces, making it the fastest and most reliable way to interact with Splitwise programmatically.
66

77
## Features 🎉
88

99
**Blazing Fast** – Optimized for performance across all supported environments
10-
🔄 **Multi-Platform Support** – Works on Web Workers, browsers, and Node.js
10+
🔄 **Multi-Platform Support** – Works on Workers and Node.js
1111
🛡️ **Fully Typed** – Provides complete TypeScript definitions
1212
🔗 **Seamless API Integration** – Simplifies interaction with Splitwise’s API
1313
📦 **Lightweight & Efficient** – Minimal dependencies to ensure a small footprint

apps/docs/content/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ features:
2020
details: Provides complete TypeScript definitions
2121
- icon: 🔄
2222
title: Multi-Platform Support
23-
details: Works on Web Workers, browsers, and Node.js
23+
details: Works on Workers and Node.js
2424
- icon: 📦
2525
title: Lightweight & Efficient
2626
details: Minimal dependencies to ensure a small footprint

packages/splitwise-ts/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Splitwise Typescript
22

3-
A high-performance, fully typed SDK for integrating with Splitwise, designed for maximum speed and flexibility. This SDK is compatible with Web Workers, browsers, and Node.js, ensuring seamless usage across different environments. Built with TypeScript, it offers robust type safety and developer-friendly interfaces, making it the fastest and most reliable way to interact with Splitwise programmatically.
3+
A high-performance, fully typed SDK for integrating with Splitwise, designed for maximum speed and flexibility. This SDK is compatible with Workers and Node.js, ensuring seamless usage across different environments. Built with TypeScript, it offers robust type safety and developer-friendly interfaces, making it the fastest and most reliable way to interact with Splitwise programmatically.
44

55
## Features 🎉
66

77
**Blazing Fast** – Optimized for performance across all supported environments
8-
🔄 **Multi-Platform Support** – Works on Web Workers, browsers, and Node.js
8+
🔄 **Multi-Platform Support** – Works on Workers and Node.js
99
🛡️ **Fully Typed** – Provides complete TypeScript definitions
1010
🔗 **Seamless API Integration** – Simplifies interaction with Splitwise’s API
1111
📦 **Lightweight & Efficient** – Minimal dependencies to ensure a small footprint

0 commit comments

Comments
 (0)