Skip to content

Commit a39f8db

Browse files
committed
chore(docs): minor tweaks to README.md
1 parent 278250a commit a39f8db

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ A modern, type-safe Kotlin client for the Notion API with comprehensive DSL supp
1313
1414
## Why This Client?
1515

16-
- **🆕 Latest API Support** - Built for Notion API version **2025-09-03** with full support for data sources, search, and all current features
16+
- **🆕 Latest API Support** - Built for Notion API version **2025-09-03** with full support for data sources, search, and all current features (currently the only Kotlin client supporting this API version)
1717
- **🛡️ Type-Safe DSLs** - Intuitive builder patterns for pages, databases, blocks, and queries with compile-time safety
1818
- **⚡ Kotlin-First** - Leverages coroutines for non-blocking I/O, null-safety, and functional programming patterns
1919
- **✅ Extensively Tested** - Validated against official Notion API sample responses with comprehensive test coverage
@@ -136,7 +136,8 @@ See [docs/databases.md](docs/databases.md) and [docs/data-sources.md](docs/data-
136136
- **Advanced query DSL** with complex filters, sorting, and pagination
137137
- **Rich text DSL** for formatted content with mentions, equations, and links
138138
- **30+ block types** including tables, callouts, code blocks, and embeds
139-
- **Property types** - All database property types supported (formulas, relations, rollups, etc.)
139+
- **Property types** - Full support for the most important data source property types, with more coming up
140+
- **Kotlin datetime types** - Native support for `kotlinx-datetime` types (`LocalDate`, `LocalDateTime`, `Instant`) with explicit timezone handling
140141
- **File operations** - Upload and manage files/images
141142
- **Comprehensive error handling** with detailed error types
142143

@@ -207,10 +208,11 @@ This library covers virtually all aspects of the Notion API (2025-09-03 version)
207208
- Review the test coverage for your specific use cases
208209
- Test thoroughly with your Notion workspace
209210
- Be aware that the API version support is fixed to 2025-09-03
211+
- **Date/time properties with timezones**: While the library provides comprehensive support for `kotlinx-datetime` types with explicit timezone handling (including timezone-aware conversions via `toLocalDateTime(timeZone)`), this area may benefit from additional real-world validation, particularly around timezone edge cases and complex datetime scenarios
210212

211213
## Contributing
212214

213-
Contributions are welcome! This project is in pre-release, so now is a great time to help shape its direction.
215+
Contributions are welcome!
214216

215217
**Areas where contributions are especially valued:**
216218
- Real-world usage feedback and bug reports
@@ -228,6 +230,7 @@ This project is licensed under the MIT License.
228230
- **Anthropic** for Claude and Claude Code
229231
- **JetBrains** for Kotlin and the fantastic language ecosystem
230232
- The **Kotlin community** for patterns and best practices
233+
- **Previous Kotlin implementations** ([klibnotion](https://github.com/BoD/klibnotion) and [notion-sdk-kotlin](https://github.com/notionsdk/notion-sdk-kotlin)) for pioneering Kotlin-based Notion API clients and serving as valuable references during development
231234

232235
---
233236

0 commit comments

Comments
 (0)