SwiftGitX

欢迎来到 SwiftGitX！🎉

SwiftGitX 是一个现代 Swift 封装，用于 libgit2。它的设计旨在使在 Swift 中使用 Git 变得简单而高效。此外，它完全支持 Swift Package Manager 并且没有任何外部依赖项。

let url = URL(string: "https://github.com/ibrahimcetin/SwiftGitX.git")!
let repository = try await Repository.clone(from: url, to: URL(string: "/path/to/clone")!)

let latestCommit = try repository.HEAD.target as? Commit

let main = try repository.branch.get(named: "main")
let feature = try repository.branch.create(named: "feature", from: main)
try repository.switch(to: feature)

SwiftGitX 提供：

• Swift 并发支持：利用 async/await 进行流畅、非阻塞的 Git 操作。
• 抛出异常的函数：使用 Swift 的错误处理机制优雅地处理错误。
• 完全的 SPM 支持：轻松将 SwiftGitX 集成到您的项目中。
• 直观的设计：一个用户友好的 API，类似于 Git 命令行界面，使其易于学习和使用。
• 封装器，不仅仅是绑定：SwiftGitX 提供完整的 Swift 体验，没有底层 C 函数或类型。它还包括现代 Git 命令，提供比其他库更多的功能。

要开始使用，只需将 SwiftGitX 添加到您的项目

1. 文件 > 添加 Package 依赖...
2. 输入 https://github.com/ibrahimcetin/SwiftGitX.git
3. 选择 "Up to Next Major" 并设置版本为 "0.1.0"

或将 SwiftGitX 添加到您的 Package.swift 文件

dependencies: [
    .package(url: "https://github.com/ibrahimcetin/SwiftGitX.git", from: "0.1.0"),
]

您可以通过三种方式访问文档：

• 在线文档 – 基于最新的已标记版本：在此查看。
• Xcode 文档 - 感谢 Swift-Docc，您可以在 Xcode 中无缝访问所有内容。
• 上游文档 – 反映来自主分支的最新更改：在此查看。

SwiftGitX 易于构建和测试。它只需要 Swift，没有额外的系统依赖。要构建 SwiftGitX，请运行

swift build

要测试 SwiftGitX，请运行

swift test

我们欢迎贡献！ 无论您是想报告错误、请求功能、改进文档还是添加测试，我们都感谢您的帮助。

对于开发者，在贡献时，请务必添加适当的测试和文档，以保持我们的项目健壮且有良好的文档记录。

感谢您考虑将 SwiftGitX 用于您的项目。 我很高兴看到您将构建什么！ 😊

如果您想进一步调整任何内容，请随时告诉我！ 🚀