Skip to content

Commit 537292b

Browse files
committed
Edit README
- Added note that not all features listed are currently built or fully implemented. - Tweaked a number of spelling and grammar mistakes. - Added a couple more contributing guidelines.
1 parent b3aa123 commit 537292b

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ A straightforward solution for using the AT Protocol and Bluesky, written in Swi
66

77
ATProtoKit is an easy-to-understand API library that leverages the AT Protocol with the type-safety and ease-of-use you’ve come to expect with the Swift programming language. Whether you’re building a bot, a server app, or just another user-facing Bluesky client, this project should hopefully get you up to speed.
88

9+
910
## Example Usage
1011
```swift
1112
let config = ATProtocolConfiguration(handle: "example.bsky.social", appPassword: "app-password")
@@ -24,6 +25,7 @@ Task {
2425
## Motivation
2526
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.
2627

28+
2729
## Features
2830
- Full compatibility with Apple’s APIs for each of the platforms.
2931
- Written with adherence to the Swift API Design Guidelines and up-to-date best practices.
@@ -35,6 +37,9 @@ I believe Bluesky and its accompanying AT Protocol gives the perfect balance bet
3537
- An HTML-parsing system to grab search engine-friendly elements for embeds.
3638
- A logging tool for easy debugging.
3739

40+
\* _Not all features above have been implemented; however, they will be, soon._
41+
42+
3843
## Installation
3944
You can use the Swift Package Manager to download and import the library into your project:
4045
```swift
@@ -43,6 +48,7 @@ dependencies: [
4348
]
4449
```
4550

51+
4652
## Roadmap
4753
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:
4854
- Making the library fully compatible for Linux, for both client-side and server-side applications.
@@ -85,14 +91,16 @@ To use ATProtoKit in your apps, your app should target the specific version numb
8591
- **macOS** 12 or later.
8692
- **tvOS** 13 or later.
8793
- **watchOS** 6 or later.
88-
(Given now new it is, there are no version requirements for **visionOS**.)
94+
(Given how new it is, there are no version requirements for **visionOS**.)
8995

9096
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.
9197

98+
9299
## Contributions and Feedback
93100
While this project will change significantly, early feedback, issues, and contributions is highly welcomed and encouraged. At a later date, I'll post some contributor guidelines and templates, but since this project is in its early days, I have yet to have a significant amount of time in terms of thinking of this. However, some of the things to keep in mind are:
94101
- Be sure to adhere to the [Swift API Design Guidelines](https://www.swift.org/documentation/api-design-guidelines/) when contributing code.
95-
-
102+
- When writing documentation, make sure it's clear, understandable, and comprehensible enough for users (both experienced and new) to understand it.
103+
- Try to follow the (Git commit best practices)[https://cbea.ms/git-commit/].
96104

97105
## License
98106
This Swift Package is using the MIT License. Please view LICENSE.md for more details.

0 commit comments

Comments
 (0)