Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
- Preparing for 0.18.0 (at long last!).
- Added link to Projects section.
- Added requirements for running ATProtoKit
on Linux.
- Tweaked warning about running ATProtoKit on
other platforms.
  • Loading branch information
MasterJ93 committed Oct 17, 2024
1 parent 6354871 commit 2aef6cb
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ I believe Bluesky and its accompanying AT Protocol gives the perfect balance bet
You can use the Swift Package Manager to download and import the library into your project:
```swift
dependencies: [
.package(url: "https://github.com/MasterJ93/ATProtoKit.git", from: "0.17.0")
.package(url: "https://github.com/MasterJ93/ATProtoKit.git", from: "0.18.0")
]
```

Expand All @@ -89,10 +89,7 @@ targets: [
```

## Roadmap
The Projects page isn't set up yet, so it'll be a while before you can see the progress for this project. However, some of the goals include:
- Making the library fully compatible for Linux, for both client-side and server-side applications.
- Replacing SwiftSoup to a more laser-focused Swift package dedicated for the AT Protocol and Bluesky.
- Adding a separate package for auto-generating lexicons based on the Swift API Design Guidelines, Swift best practices, and this project’s own API design guidelines.
The Projects page isn't completed, but you can still view it through its [Projects](https://github.com/users/MasterJ93/projects/2) page.

## Quick Start
As shown in the Example Usage, it all starts with `ATProtocolConfiguration`, which uses the handle, app password, and pdsURL to access and create a session:
Expand Down Expand Up @@ -129,10 +126,17 @@ To use ATProtoKit in your apps, your app should target the specific version numb
- **visionOS** 1 or later.
- **watchOS** 9 or later.

For Linux, you need to use Swift 6.0 or later. At this time, use must use `@preconcurrency` when importing ATProtoKit. On Linux, the minimum requirements include:
- **Ubuntu** 18.04
- **CentOS** 7
- **Red Hat UBI** 9
- **Debian** 12
- **Fedora** 39

You can also use this project for any programs you make using Swift and running on **Docker**.

> [!WARNING]
> As of right now, Linux support is theoretically possible, but not guaranteed to be tested. The plan is to make it fully compatible with Linux by version 1.0, though this is not a required goal to get there. For other platforms (such as Android), this is also not tested, but should be theoretically possible. While it’s not a goal to make it fully compatible, contributions and feedback on the matter are welcomed.
> As of right now, Windows support is theoretically possible, but not has not been tested to work. For other platforms (such as Android), this is also not tested, but should be theoretically possible. While it’s not a goal to make it fully compatible, contributions and feedback on the matter are welcomed.

## Submitting Contributions and Feedback
Expand Down

0 comments on commit 2aef6cb

Please sign in to comment.