{"id":18351425,"url":"https://github.com/writefreely/writefreely-swift","last_synced_at":"2026-03-03T16:40:49.766Z","repository":{"id":39793273,"uuid":"274663423","full_name":"writefreely/writefreely-swift","owner":"writefreely","description":"A Swift package wrapping the WriteFreely / Write.as API","archived":false,"fork":false,"pushed_at":"2023-12-29T14:01:45.000Z","size":153,"stargazers_count":9,"open_issues_count":7,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-02-05T14:25:36.778Z","etag":null,"topics":["swift","writefreely"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/writefreely.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-06-24T12:29:28.000Z","updated_at":"2024-05-30T12:32:57.000Z","dependencies_parsed_at":"2022-09-26T18:11:38.716Z","dependency_job_id":"e405b410-149d-4e96-b73d-6f97d63291d3","html_url":"https://github.com/writefreely/writefreely-swift","commit_stats":{"total_commits":68,"total_committers":2,"mean_commits":34.0,"dds":"0.044117647058823484","last_synced_commit":"4919bb1edcfceafe134fdac7e5c9d2e5b8a43cc8"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/writefreely/writefreely-swift","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/writefreely%2Fwritefreely-swift","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/writefreely%2Fwritefreely-swift/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/writefreely%2Fwritefreely-swift/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/writefreely%2Fwritefreely-swift/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/writefreely","download_url":"https://codeload.github.com/writefreely/writefreely-swift/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/writefreely%2Fwritefreely-swift/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30052112,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-03T15:26:47.567Z","status":"ssl_error","status_checked_at":"2026-03-03T15:26:17.132Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["swift","writefreely"],"created_at":"2024-11-05T21:30:59.874Z","updated_at":"2026-03-03T16:40:49.741Z","avatar_url":"https://github.com/writefreely.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WriteFreely\n\n[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fwritefreely%2Fwritefreely-swift%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/writefreely/writefreely-swift)\n[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fwritefreely%2Fwritefreely-swift%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/writefreely/writefreely-swift)\n\nA Swift package that wraps the [WriteFreely](https://writefreely.org) API, for use in your Swift projects.\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing\npurposes. See _Deployment_ for notes on how to add the library to your app.\n\n### Prerequisites\n\nYou'll need Xcode 11.5 / Swift 5.2 installed along with the command line tools to work on this package.\n\nAdditionally, documentation is generated by [SwiftDoc](https://github.com/SwiftDocOrg/swift-doc). After making any\nchanges to the package's public API, you'll need to regenerate the docs; to do so, run the following commands in the\nterminal from the root directory of the package:\n\n```bash\n$ swift doc generate Sources --module-name WriteFreely --format html --output ./docs --base-url https://writefreely.github.io/writefreely-swift/\n```\n\n### Installing\n\n1. Clone this repository.\n2. There is no step two.\n\n## Running the tests\n\nRun the tests from the command line:\n\n```bash\n$ swift build\n$ swift test\n```\n\n## Deployment\n\nFollow the instructions in this [Apple Developer document](https://developer.apple.com/documentation/swift_packages/adding_package_dependencies_to_your_app) to add the `WriteFreely` Swift package to your app.\n\nOnce you've done that, just import the library into whichever files should consume it:\n\n```swift\n@import Foundation  // Or UIKit, Cocoa, \u0026cet.\n@import WriteFreely\n\n// The rest of the Swift file goes here\n```\n\nUse public methods on the `WFClient` to send and receive data from the server. The methods leverage completion blocks\nand the `Result` type, so you'd call them like so:\n\n```swift\nguard let instanceURL = URL(string: \"https://your.writefreely.host/\") else { fatalError() }\nlet client = WFClient(for: instanceURL)\nclient.login(username: \"username\", password: \"password\", completion: { result in\n    switch(result) {\n    case .success():\n        // Do something with the returned WFUser\n    case .failure():\n        // Do something with the returned WFError\n    }\n})\n```\n\nSee [the API documentation](https://developers.write.as/docs/api/?swift) for more details. Xcode-specific documentation\nis also available [here](https://writefreely.github.io/writefreely-swift/).\n\n## Contributing\n\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull\nrequests to us.\n\nNeed help getting started? Find out more about the project's [office hours](https://discuss.write.as/t/office-hours-for-writefreely-swift-projects/2788).\n\n## Versioning\n\nWe use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/writeas/writefreely-swift/tags).\n\n## Authors\n\n* **Angelo Stavrow** - *Initial work* - [AngeloStavrow](https://github.com/AngeloStavrow)\n\nSee also the list of [contributors](https://github.com/writeas/writefreely-swift/contributors) who participated in this project.\n\n## License\n\nThis project is licensed under the BSD 3-Clause License - see the [LICENSE.md](LICENSE.md) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwritefreely%2Fwritefreely-swift","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwritefreely%2Fwritefreely-swift","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwritefreely%2Fwritefreely-swift/lists"}