Skip to content

v0.5.1 #20

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
tkoehlerlg merged 1 commit into from
Nov 19, 2025
Merged

v0.5.1 #20

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
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ A fast TypeScript Scheduling SDK for finding available time slots with **excepti

- **🎯 DX First**: Intuitive APIs that feel intuitive to use
- **🔒 Full TypeScript Support**: Complete type safety with excellent IntelliSense
- **📦 Dual Module Support**: Works with both ESM and CommonJS (NestJS compatible!)
- **📖 Extensive Documentation**: In-depth guides, examples, and API references (With help by Claude)
- **⚡ Blazing Fast Performance**: Optimized algorithms for handling large datasets
- **🔧 Flexible Configuration**: Customizable slot duration, padding, splitting, and offset
Expand All @@ -21,7 +22,7 @@ A fast TypeScript Scheduling SDK for finding available time slots with **excepti
- **🧪 98%+ Test Coverage**: Comprehensive testing with edge case handling (Supported by the [CODE's](https://code.berlin) Automated Testing LU)

> **Note**
> The SDK is fully written in TypeScript and uses Bun as the build and test tool. It requires TypeScript 5.0 or later as a peer dependency. While we use Bun for development, the compiled SDK is compatible with any JavaScript runtime, including Node.js, Deno, and modern browsers with ESM support.
> The SDK is fully written in TypeScript and uses Bun as the build and test tool. It requires TypeScript 5.0 or later as a peer dependency. While we use Bun for development, the compiled SDK is compatible with any JavaScript runtime (Node.js, Deno, browsers) and works with both ESM and CommonJS module systems.

## Quick Start 💨

Expand All @@ -34,6 +35,20 @@ bun add scheduling-sdk

**Zero configuration required** - start scheduling in seconds! 🚀

### Module Compatibility

The SDK supports both ESM and CommonJS module systems:

```typescript
// ESM (Modern)
import { Scheduler, AvailabilityScheduler } from 'scheduling-sdk'

// CommonJS (NestJS, older Node.js)
const { Scheduler, AvailabilityScheduler } = require('scheduling-sdk')
```

Both formats provide identical functionality and TypeScript support.

## Core Concepts

- **Busy Times**: Periods when you're NOT available (meetings, appointments, breaks)
Expand Down
Loading