Skip to content

Commit f970384

Browse files
committed
docs: move changelog to collapsible <details> at end of README
The "What's new" sections for 0.2.0 and 0.3.0 used to live up top, pushing the usage examples below the fold. Moved them into a Changelog section at the end with <details>/<summary> so they default to collapsed; the install block now flows directly into Usage.
1 parent 089e614 commit f970384

1 file changed

Lines changed: 42 additions & 31 deletions

File tree

README.md

Lines changed: 42 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -13,37 +13,6 @@ Install
1313
pip install charguana
1414
```
1515

16-
### What's new in 0.3.0
17-
18-
- **Emoji support.** New `charguana.emoji` module bundles parsed Unicode
19-
emoji data (latest version).
20-
- `get_charset('emoji')` returns the list of single-codepoint
21-
Emoji_Presentation characters.
22-
- `is_emoji(s)` — True for a single emoji char or a known multi-char
23-
sequence (flags, ZWJ combos, keycaps, modifier sequences).
24-
- `charguana.emoji.emoji_sequences`, `emoji_zwj_sequences`,
25-
`emoji_properties` for finer access. All lazy-loaded.
26-
- `fetch_emoji(version='latest')` hits unicode.org for fresh data at
27-
runtime (requires network; no side effects on disk).
28-
- Maintainer tooling: `scripts/refresh_emoji.py` regenerates the bundled
29-
emoji data files from unicode.org. Alongside the existing
30-
`scripts/generate_perluniprops.sh`.
31-
32-
### What's new in 0.2.0
33-
34-
- `get_charset(name)` now returns a **list** instead of a generator. Use
35-
`iter_charset(name)` if you want the old lazy behavior.
36-
- `all_in_charset(string, charset)` added alongside `islang` — the former
37-
requires every character to match; `islang` remains "any character
38-
matches".
39-
- `is_in_charsets(ch, ranges)` is now exposed at the top level (previously
40-
only in `charguana.korean`).
41-
- `perluniprops` props (`IsAlpha`, `IsAlnum`, `IsLower`, `IsUpper`, `IsSo`)
42-
and `chinese_strokes` are now loaded lazily on first access, so
43-
`import charguana` is cheap.
44-
- Multiple Vietnamese IME bug fixes (VNI `U7*`, `O1..5`, `U1..5`; Telex
45-
`Uws/Owf/Os/Us` families previously produced the wrong vowel).
46-
4716

4817
Usage
4918
====
@@ -268,3 +237,45 @@ KeyError: 'u8'
268237
>>> telex_ime('Nguyeefn Traafn Anh Thuw')
269238
'Nguyền Trần Anh Thư'
270239
```
240+
241+
242+
Changelog
243+
====
244+
245+
<details>
246+
<summary><b>0.3.0</b> — Emoji support</summary>
247+
248+
- **Emoji support.** New `charguana.emoji` module bundles parsed Unicode
249+
emoji data (latest version).
250+
- `get_charset('emoji')` returns the list of single-codepoint
251+
Emoji_Presentation characters.
252+
- `is_emoji(s)` — True for a single emoji char or a known multi-char
253+
sequence (flags, ZWJ combos, keycaps, modifier sequences).
254+
- `charguana.emoji.emoji_sequences`, `emoji_zwj_sequences`,
255+
`emoji_properties` for finer access. All lazy-loaded.
256+
- `fetch_emoji(version='latest')` hits unicode.org for fresh data at
257+
runtime (requires network; no side effects on disk).
258+
- Maintainer tooling: `scripts/refresh_emoji.py` regenerates the bundled
259+
emoji data files from unicode.org. Alongside the existing
260+
`scripts/generate_perluniprops.sh`.
261+
262+
</details>
263+
264+
<details>
265+
<summary><b>0.2.0</b> — Bug fixes, lazy loading, modern packaging</summary>
266+
267+
- `get_charset(name)` now returns a **list** instead of a generator. Use
268+
`iter_charset(name)` if you want the old lazy behavior.
269+
- `all_in_charset(string, charset)` added alongside `islang` — the former
270+
requires every character to match; `islang` remains "any character
271+
matches".
272+
- `is_in_charsets(ch, ranges)` is now exposed at the top level (previously
273+
only in `charguana.korean`).
274+
- `perluniprops` props (`IsAlpha`, `IsAlnum`, `IsLower`, `IsUpper`, `IsSo`)
275+
and `chinese_strokes` are now loaded lazily on first access, so
276+
`import charguana` is cheap.
277+
- Multiple Vietnamese IME bug fixes (VNI `U7*`, `O1..5`, `U1..5`; Telex
278+
`Uws/Owf/Os/Us` families previously produced the wrong vowel).
279+
280+
</details>
281+

0 commit comments

Comments
 (0)