Skip to content

Commit 97d1729

Browse files
committed
docs: Add Table of Contents and remove marketing language
- Add TOC for README >200 lines (now 254 lines) - Remove marketing word 'seamlessly' from Features section - All 62 tests still passing
1 parent 8c25e5a commit 97d1729

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@
77

88
Type-safe domain name handling for Swift with multi-RFC standard support.
99

10+
## Table of Contents
11+
12+
- [Overview](#overview)
13+
- [Features](#features)
14+
- [Installation](#installation)
15+
- [Quick Start](#quick-start)
16+
- [Usage Examples](#usage-examples)
17+
- [Architecture](#architecture)
18+
- [Error Handling](#error-handling)
19+
- [Related Packages](#related-packages)
20+
- [Requirements](#requirements)
21+
- [License](#license)
22+
- [Contributing](#contributing)
23+
1024
## Overview
1125

1226
`swift-domain-type` provides a unified `Domain` type that supports multiple RFC standards for domain names:
@@ -19,7 +33,7 @@ The library automatically selects the most appropriate RFC format based on the i
1933

2034
## Features
2135

22-
- **Multi-RFC Support**: Seamlessly handles RFC 1035, 1123, and 5321 formats
36+
- **Multi-RFC Support**: Handles RFC 1035, 1123, and 5321 formats
2337
- **Type Safety**: Compile-time guarantees with Swift 6.0 strict concurrency
2438
- **Domain Operations**: Add subdomains, get parent domains, check subdomain relationships
2539
- **Component Access**: Extract TLD, SLD, and domain labels

0 commit comments

Comments
 (0)