Skip to content

Commit ee5c5c7

Browse files
authored
Rename package to ToonFormat (#5)
1 parent 3d9f564 commit ee5c5c7

5 files changed

Lines changed: 24 additions & 13 deletions

File tree

β€ŽCONTRIBUTING.mdβ€Ž

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to TOONEncoder
1+
# Contributing to toon-swift
22

33
Thank you for your interest in contributing to the official Swift implementation of TOON!
44

@@ -9,7 +9,7 @@ This project uses Swift Package Manager for dependency management and build auto
99
```bash
1010
# Clone the repository
1111
git clone https://github.com/toon-format/toon-swift.git
12-
cd TOONEncoder
12+
cd toon-swift
1313

1414
# Build the project
1515
swift build
@@ -63,6 +63,7 @@ This project requires Swift 6.0 and above.
6363
- Maintain test coverage at **85%+ line coverage**
6464
- Tests should cover edge cases and spec compliance
6565
- Run the full test suite:
66+
6667
```bash
6768
swift test
6869

β€ŽPackage.swiftβ€Ž

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import PackageDescription
55

66
let package = Package(
7-
name: "TOONEncoder",
7+
name: "ToonFormat",
88
platforms: [
99
.iOS("13.0"),
1010
.macOS("10.15"),
@@ -15,19 +15,19 @@ let package = Package(
1515
products: [
1616
// Products define the executables and libraries a package produces, making them visible to other packages.
1717
.library(
18-
name: "TOONEncoder",
19-
targets: ["TOONEncoder"]
18+
name: "ToonFormat",
19+
targets: ["ToonFormat"]
2020
)
2121
],
2222
targets: [
2323
// Targets are the basic building blocks of a package, defining a module or a test suite.
2424
// Targets can depend on other targets in this package and products from dependencies.
2525
.target(
26-
name: "TOONEncoder"
26+
name: "ToonFormat"
2727
),
2828
.testTarget(
29-
name: "TOONEncoderTests",
30-
dependencies: ["TOONEncoder"]
29+
name: "ToonFormatTests",
30+
dependencies: ["ToonFormat"]
3131
),
3232
]
3333
)

β€ŽREADME.mdβ€Ž

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# TOONEncoder – TOON Format for Swift
1+
# TOON Format for Swift
22

33
[![CI](https://github.com/toon-format/toon-swift/actions/workflows/ci.yml/badge.svg)](https://github.com/toon-format/toon-swift/actions)
44
[![Swift Version](https://img.shields.io/badge/swift-6.0+-orange.svg)](https://swift.org)
@@ -14,6 +14,7 @@ TOON saves tokens while remaining human-readable by
1414
using indentation for structure and a tabular format for uniform data:
1515

1616
**JSON**:
17+
1718
```json
1819
{
1920
"users": [
@@ -24,6 +25,7 @@ using indentation for structure and a tabular format for uniform data:
2425
```
2526

2627
**TOON**:
28+
2729
```
2830
users[2]{id,name,role}:
2931
1,Alice,admin
@@ -53,8 +55,8 @@ and implements the following features:
5355

5456
## Requirements
5557

56-
* Swift 6.0+ / Xcode 16+
57-
* iOS 13.0+ / macOS 10.15+ / watchOS 6.0+ / tvOS 13.0+ / visionOS 1.0+
58+
- Swift 6.0+ / Xcode 16+
59+
- iOS 13.0+ / macOS 10.15+ / watchOS 6.0+ / tvOS 13.0+ / visionOS 1.0+
5860

5961
## Installation
6062

@@ -73,7 +75,7 @@ dependencies: [
7375
### Quick Start
7476

7577
```swift
76-
import TOONEncoder
78+
import ToonFormat
7779

7880
struct User: Codable {
7981
let id: Int
@@ -95,6 +97,7 @@ print(String(data: data, encoding: .utf8)!)
9597
```
9698

9799
Output:
100+
98101
```
99102
id: 123
100103
name: Ada
@@ -126,13 +129,15 @@ let data = try encoder.encode(["items": items])
126129
```
127130

128131
Output with tab delimiter:
132+
129133
```
130134
items[2 ]{sku name qty price}:
131135
A1 Widget 2 9.99
132136
B2 Gadget 1 14.5
133137
```
134138

135139
Output with pipe delimiter:
140+
136141
```
137142
items[2|]{sku|name|qty|price}:
138143
A1|Widget|2|9.99
@@ -159,6 +164,7 @@ let output = try encoder.encode(data)
159164
```
160165

161166
Output:
167+
162168
```
163169
tags[#3]: reading,gaming,coding
164170
items[#2]{sku,qty,price}:
@@ -187,6 +193,7 @@ let data = try encoder.encode(["items": items])
187193
```
188194

189195
Output:
196+
190197
```
191198
items[2]{sku,qty,price}:
192199
A1,2,9.99
@@ -205,6 +212,7 @@ let data = try encoder.encode(["pairs": pairs])
205212
```
206213

207214
Output:
215+
208216
```
209217
pairs[2]:
210218
- [2]: 1,2
@@ -238,6 +246,7 @@ let data = try encoder.encode(config)
238246
```
239247

240248
Without key folding:
249+
241250
```
242251
database:
243252
connection:
@@ -320,6 +329,7 @@ print(TOONEncoder.specVersion) // "3.0"
320329
Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details on how to get started, coding standards, and the process for submitting pull requests.
321330

322331
Before contributing, please review:
332+
323333
- [Code of Conduct](CODE_OF_CONDUCT.md)
324334
- [TOON Specification](https://github.com/toon-format/spec/blob/main/SPEC.md)
325335

Tests/TOONEncoderTests/TOONEncoderTests.swift renamed to Tests/ToonFormatTests/TOONEncoderTests.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import Foundation
22
import Testing
33

4-
@testable import TOONEncoder
4+
@testable import ToonFormat
55

66
@Suite("TOONEncoder Tests")
77
struct TOONEncoderTests {

0 commit comments

Comments
Β (0)