Skip to content

Commit 0a6c254

Browse files
committed
Edit README and ExtensionHelpers
- Small tweaks to wording and formatting.
1 parent 9b54b5c commit 0a6c254

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ Task {
2222
```
2323

2424
## Motivation
25-
I believe Bluesky and its accompanying protocol gives the perfect balance between embracing decentralization and simplifying the user experience. Because of this, I wanted a way for Swift developers to use the AT Protocol in a way that feels right at home, both client-side with Apple's platform's, and server-side with Linux. For this reason, I decided to open source this project.
25+
I believe Bluesky and its accompanying AT Protocol gives the perfect balance between embracing decentralization and simplifying the user experience. Because of this, I wanted a way for Swift developers to use the AT Protocol in a way that feels right at home, both client-side with Apple's platforms, and server-side with Linux. For this reason, I decided to open source this project.
2626

2727
## Features
2828
- Full compatibility with Apple’s APIs for each of the platforms.
2929
- Written with adherence to the Swift API Design Guidelines and up-to-date best practices.
3030
- Uses Swift’s powerful type inference and pattern matching for cleaner, more readable code.
3131
- Well-written documentation for all of the AT Protocol and Bluesky APIs.
32-
- A RichText helper to parse text into the applicable facet.
32+
- A RichText helper to parse text into the applicable facets.
3333
- Extend the capabilities of generic structures within the AT Protocol in case your instance requires it.
3434
- A powerful Firehose API that retrieves and filters events and records in real-time.
3535
- An HTML-parsing system to grab search engine-friendly elements for embeds.
@@ -54,12 +54,12 @@ As shown in the Example Usage, it all starts with `ATProtocolConfiguration`, whi
5454
```swift
5555
import ATProtoKit
5656

57-
let config = ATProtocolConfiguration(handle: "example.bsky.social", appPassword: "app-password")
57+
let config = ATProtocolConfiguration(handle: "lucy.bsky.social", appPassword: "app-password")
5858
```
5959

6060
By default, `ATProtocolConfiguration` conforms to `https://bsky.social`. However, if you’re using a different distributed service, you can specify the URL:
6161
```swift
62-
let result2 = ATProtocolConfiguration(handle: "example.example.social", appPassword: "app-password", pdsURL: "https://example.social")
62+
let result = ATProtocolConfiguration(handle: "lucy.example.social", appPassword: "app-password", pdsURL: "https://example.social")
6363
```
6464

6565
This session contains all of the elements you need, such as the access and refresh tokens:

Sources/ATProtoKit/Utilities/ExtensionHelpers.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ extension Array: Truncatable {
3434
}
3535
}
3636

37-
// MARK: Encodable Extension
37+
// MARK: - Encodable Extension
3838
extension Encodable {
3939
/// Converts an object into a JSON object.
4040
///

0 commit comments

Comments
 (0)