diff --git a/README.md b/README.md index cd0491c..e6790ed 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,29 @@ -# Outpost +

+ Outpost logo +

+ +

Outpost

+ +

+ + Download on TestFlight + +

A native Apple ecosystem client for [Outline](https://github.com/outline/outline) — built for iOS, iPadOS, and macOS from a single SwiftUI codebase, aiming for full editing parity with Outline's web app, including realtime collaborative editing. +> **Early alpha — macOS only for now.** Expect missing features and rough edges. iOS/iPadOS support is planned but not in the current build. See the [releases page](https://git.psmattas.com/psmattas/Outpost/releases) for changelogs, and [open an issue](https://git.psmattas.com/psmattas/Outpost/issues) if you hit anything. + ## Why Outline's web app is great, but there's no native Apple client with full editing parity. This project connects to a self-hosted Outline instance over its REST API and realtime collaboration socket to provide a proper native experience across the Apple ecosystem. -## Status - -Early development. See `CLAUDE.md` for the current architecture and phased build plan. - -- [ ] Phase 1 — Auth, browse, search, REST-only editing -- [ ] Phase 2 — Realtime collaborative editing (Yjs/Hocuspocus) -- [ ] Phase 3 — Offline cache, tables, embeds, comments, macOS polish - ## Requirements -- Xcode 16+ -- iOS 17+ / iPadOS 17+ / macOS 14+ +- Xcode 27+ (currently developed against an Xcode 27 beta — this is a hard minimum, not a suggestion) +- macOS 27+. iOS/iPadOS support is planned but not in the current build (see the alpha note above) — same 27+ minimum will apply once it lands - A self-hosted (or hosted) Outline instance with API access -> They will be updated. These are old requirements. - ## Setup 1. Clone the repo and open the `.xcodeproj` in Xcode. @@ -42,6 +44,16 @@ Parts of this codebase are AI-assisted (built with the help of AI coding tools). This project is a client only — it does not include, vendor, or redistribute any of Outline's (BSL 1.1 licensed) server source. See [`LICENSE`](./LICENSE) for this repository's own license. +## Privacy + +Outpost collects nothing about you — no analytics, no telemetry, no crash reporting of its own, no age or demographic data, nothing. The only thing stored locally is your Outline server URL and API token (in the device Keychain) and, optionally, a local offline cache of what you've viewed. Everything else goes straight from your device to whatever Outline server you configure — there's no backend in between, and the developer has no access to your data or your server. + +Full policy, terms of service, and data-processing statement are on the [wiki](https://git.psmattas.com/psmattas/Outpost/wiki): + +- [Privacy Policy](https://git.psmattas.com/psmattas/Outpost/wiki/Privacy-Policy) +- [Terms of Service](https://git.psmattas.com/psmattas/Outpost/wiki/Terms-of-Service) +- [Data Processing Statement](https://git.psmattas.com/psmattas/Outpost/wiki/Data-Processing-Statement) + ## Not affiliated with Outline This is an independent, unofficial client. Not affiliated with or endorsed by General Outline, Inc.