Skip to content

Update README with module usage guide #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lupodevelop merged 1 commit into from
Jan 8, 2026
Merged

Update README with module usage guide #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 21 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,14 +259,30 @@ extra.slugify_opts("Hello World", 0, "_", False) // → "hello_world"

---

## 🏗️ Module Structure
## 🏗️ Module Guide

### Which module should I use?

| Module | When to use | Import |
|--------|-------------|--------|
| **`str`** | Most common operations | `import str` |
| **`str/core`** | Full grapheme-aware API, advanced features | `import str/core` |
| **`str/extra`** | ASCII folding, slugs, case conversions | `import str/extra` |
| **`str/tokenize`** | Reference implementation (pedagogic only) | `import str/tokenize` |

Copilot AI Jan 8, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The term "pedagogic" should be "pedagogical" for proper grammar. "Pedagogical" is the standard adjective form when describing something educational or instructional in nature.

Suggested change
| **`str/tokenize`** | Reference implementation (pedagogic only) | `import str/tokenize` |
| **`str/tokenize`** | Reference implementation (pedagogical only) | `import str/tokenize` |

Copilot uses AI. Check for mistakes.

**Quick start:** Use `import str` for everyday needs. The main `str` module re-exports commonly used functions from `core` and `extra`.

**Advanced users:** Import `str/core` and `str/extra` directly when you need the complete API or want explicit control.

### Module structure

```
str/
├── core # Grapheme-aware core utilities
├── extra # ASCII folding, slugs, case conversions
├── tokenize # Pure-Gleam tokenizer (reference)
└── internal_* # Character tables (internal)
├── str.gleam # Main module (re-exports common functions)
├── core.gleam # Grapheme-aware utilities
├── extra.gleam # ASCII folding, slugs, case conversions
├── tokenize.gleam # Pure-Gleam tokenizer (reference)
└── internal_* # Character tables (not public API)
```

---
Expand Down