Skip to content

Commit 52edb03

Browse files
author
Demo User
committed
docs: Update README and CHANGELOG for v1.0.1
- Restore Overview and For AI Agents sections in README - Add proper project introduction at the beginning - Update CHANGELOG with v1.0.1 release notes - Reorganize README structure with better section separation
1 parent d750001 commit 52edb03

2 files changed

Lines changed: 64 additions & 8 deletions

File tree

CHANGELOG.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
---
99

10+
## [1.0.1] - 2025-03-11
11+
12+
### Added
13+
- **NPM Package Support**: Package now available on npm registry
14+
- **CLI Tool (`pto`)**: Command-line interface for all operations
15+
- **On-demand Font Download**: Fonts downloaded via `pto download-fonts` instead of bundled
16+
- **Node.js API**: Full JavaScript/TypeScript API support
17+
- **GitHub Actions CI/CD**: Automated testing and publishing workflows
18+
- **TypeScript Definitions**: Complete type definitions in `types/`
19+
20+
### Changed
21+
- **Package Size**: Reduced from ~76MB to 27.7KB (99.9% reduction)
22+
- **Font Distribution**: Fonts are no longer bundled, downloaded on-demand
23+
- **Installation**: Improved post-install checks and user feedback
24+
- **Documentation**: Updated all README files with npm installation instructions
25+
26+
### Removed
27+
- Bundled font files from npm package (now downloaded on demand)
28+
- Example outputs and large asset files from package
29+
- Deprecated example files (moved to documentation)
30+
31+
### Technical Improvements
32+
- Added `postinstall.js` for better setup experience
33+
- Added `download-fonts.js` for font management
34+
- Improved `.npmignore` to exclude unnecessary files
35+
- Added `files` field in `package.json` for precise package content control
36+
37+
---
38+
1039
## [1.0.0] - 2025-03-11
1140

1241
### Added

README.md

Lines changed: 35 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,28 @@
99

1010
---
1111

12+
## Overview
13+
14+
AI-generated images often contain garbled or imperfect text, especially for Chinese, Japanese, Korean (CJK) and other non-Latin scripts. This tool solves this problem by separating image generation and text rendering into two distinct steps:
15+
16+
1. **Generate a clean base image** without text
17+
2. **Analyze optimal text placement zones**
18+
3. **Render text** with professional typography and effects
19+
20+
---
21+
22+
## For AI Agents (Natural Language Installation)
23+
24+
Copy and paste this prompt to your LLM agent (Claude Code, Kimi Code, Cursor, etc.):
25+
26+
```
27+
Install the perfect-text-overlay skill to my workspace.
28+
Clone from: https://github.com/stephenlzc/perfect-text-overlay
29+
Set up all dependencies and verify the installation by running a test with Chinese text extraction.
30+
```
31+
32+
---
33+
1234
## Quick Start
1335

1436
```bash
@@ -25,14 +47,7 @@ pto download-fonts --all
2547
pto separate "Generate a poster with 'Summer Sale' title"
2648
```
2749

28-
## What It Does
29-
30-
AI-generated images often have garbled text, especially for Chinese/Japanese/Korean. This tool fixes that by:
31-
32-
1. **Separate** prompt → image-only prompt + text requirements
33-
2. **Generate** clean base image (use your AI of choice)
34-
3. **Analyze** image for best text placement
35-
4. **Render** perfect text with professional typography
50+
---
3651

3752
## Installation
3853

@@ -53,6 +68,8 @@ cd perfect-text-overlay
5368
npm install
5469
```
5570

71+
---
72+
5673
## CLI Usage
5774

5875
```bash
@@ -73,6 +90,8 @@ pto download-fonts --list
7390
pto download-fonts --all
7491
```
7592

93+
---
94+
7695
## Node.js API
7796

7897
```javascript
@@ -93,6 +112,8 @@ async function createPoster() {
93112
}
94113
```
95114

115+
---
116+
96117
## Font Styles
97118

98119
| Style | Language | Description |
@@ -107,6 +128,8 @@ async function createPoster() {
107128

108129
Download fonts: `pto download-fonts --all`
109130

131+
---
132+
110133
## Project Structure
111134

112135
```
@@ -121,12 +144,16 @@ perfect-text-overlay/
121144
└── types/ # TypeScript definitions
122145
```
123146

147+
---
148+
124149
## Documentation
125150

126151
- [API Reference](API.md) - Detailed API documentation
127152
- [Contributing](CONTRIBUTING.md) - Contribution guidelines
128153
- [CHANGELOG](CHANGELOG.md) - Version history
129154

155+
---
156+
130157
## License
131158

132159
MIT © [stephenlzc](https://github.com/stephenlzc)

0 commit comments

Comments
 (0)