Skip to content

Commit bdfd48a

Browse files
author
km-kwon
committed
DOCS: Add CHANGELOG.md to document changes per version
1 parent b6978dc commit bdfd48a

2 files changed

Lines changed: 32 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [1.0.1] - 2025-12-23
8+
9+
### Changed
10+
11+
- Added GitHub repository URL to package.json
12+
- Added homepage and bug tracker links
13+
- Improved npm package metadata
14+
15+
## [1.0.0] - 2025-12-22
16+
17+
### Added
18+
19+
- Initial release
20+
- CircularBuffer low-level API for direction-based circular buffer operations
21+
- BufferManager high-level API with convenient push/pop/peek methods
22+
- React hook: `useCircularBuffer` for stateful React integration
23+
- Full TypeScript support with generics
24+
- Zero dependencies (React as optional peer dependency)
25+
- O(1) push/pop/peek operations
26+
- Support for React 16.8+, 17, 18, 19
27+
- Comprehensive documentation and examples
28+
- Type-safe implementation with complete API reference

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "circular-queue-react",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"description": "High-performance circular buffer/queue for TypeScript and React - Perfect for logs, streaming data, and real-time updates",
55
"main": "dist/index.js",
66
"module": "dist/esm/index.js",
@@ -44,10 +44,10 @@
4444
},
4545
"repository": {
4646
"type": "git",
47-
"url": "https://github.com/yourusername/circular-queue-react.git"
47+
"url": "https://github.com/km-kwon/react-circular-queue.git"
4848
},
4949
"bugs": {
50-
"url": "https://github.com/yourusername/circular-queue-react/issues"
50+
"url": "https://github.com/km-kwon/react-circular-queue/issues"
5151
},
52-
"homepage": "https://github.com/yourusername/circular-queue-react#readme"
52+
"homepage": "https://github.com/km-kwon/react-circular-queue#readme"
5353
}

0 commit comments

Comments
 (0)