WriteFreely

一个 Swift 包，封装了 WriteFreely API，用于您的 Swift 项目中。

这些说明将帮助您在本地机器上启动并运行项目副本，以进行开发和测试。有关如何将库添加到您的应用程序的说明，请参阅部署部分。

您需要安装 Xcode 11.5 / Swift 5.2 以及命令行工具才能使用此软件包。

此外，文档由 SwiftDoc 生成。在对软件包的公共 API 进行任何更改后，您需要重新生成文档；为此，请从软件包的根目录在终端中运行以下命令

$ swift doc generate Sources --module-name WriteFreely --format html --output ./docs --base-url https://writefreely.github.io/writefreely-swift/

1. 克隆此仓库。
2. 没有第二步。

从命令行运行测试

$ swift build
$ swift test

请按照此 Apple 开发者文档 中的说明将 WriteFreely Swift 软件包添加到您的应用程序中。

完成上述操作后，只需将库导入到需要使用它的任何文件中即可

@import Foundation  // Or UIKit, Cocoa, &cet.
@import WriteFreely

// The rest of the Swift file goes here

使用 WFClient 上的公共方法来发送和接收来自服务器的数据。这些方法利用了完成块和 Result 类型，因此您可以像这样调用它们

guard let instanceURL = URL(string: "https://your.writefreely.host/") else { fatalError() }
let client = WFClient(for: instanceURL)
client.login(username: "username", password: "password", completion: { result in
    switch(result) {
    case .success():
        // Do something with the returned WFUser
    case .failure():
        // Do something with the returned WFError
    }
})

有关更多详细信息，请参阅 API 文档。Xcode 专用文档也在此处 提供。

请阅读 CONTRIBUTING.md 以了解有关我们行为准则的详细信息，以及向我们提交拉取请求的流程。

需要帮助入门吗？了解更多关于项目办公时间的信息。

我们使用 SemVer 进行版本控制。对于可用的版本，请参阅此仓库上的标签。

• Angelo Stavrow - 初始工作 - AngeloStavrow

另请参阅参与此项目的贡献者列表。

此项目根据 BSD 3-Clause 许可证获得许可 - 有关详细信息，请参阅 LICENSE.md 文件。