Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[0.4.0] - 2024-12-19
Added
- Comprehensive documentation restructuring
- ReadTheDocs integration for better documentation hosting
- Improved README with focus on quick start and key features
Changed
- Moved detailed API documentation to ReadTheDocs
- Streamlined README following open-source best practices
- Enhanced project structure and organization
[Unreleased]
Added
- Initial TypeScript client implementation
- Publication details fetching
- Post retrieval and search functionality
- Comment system support
- Pagination support
- Error handling with custom error types
- Full TypeScript type definitions
Features
- Publications: Fetch publication details and metadata
- Posts: Get posts, search by criteria, and access individual posts
- Comments: Retrieve comments and comment threads
- Pagination: Built-in pagination for all list operations
- TypeScript: Full type safety with comprehensive type definitions
- Error Handling: Custom error types for API-related errors
- Configuration: Support for different API versions and custom configurations
Release Notes
For the latest releases and detailed release notes, please visit our GitHub Releases page.
Migration Guide
From v0.3.x to v0.4.x
No breaking changes in this version. All existing code should continue to work as expected.
Contributing to Changelog
When adding new features or making changes:
- Add entries to the "Unreleased" section
- Follow the Keep a Changelog format
- Categorize changes as Added, Changed, Deprecated, Removed, Fixed, or Security
- Move entries to a versioned section when releasing