diff --git a/README.md b/README.md new file mode 100644 index 00000000..8d638702 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Coves Frontend + +Web frontend for [Coves](https://github.com/BrettM86/coves), a forum-style social platform built on [atProto](https://atproto.com/). + +Based on [Photon](https://github.com/Xyphyn/photon) by [Xyphyn](https://github.com/Xyphyn) — a Svelte-based Lemmy client — adapted for the Coves AppView and atProto identity. + +## Development + +```sh +bun install +bun run dev +``` + +Built with [SvelteKit](https://svelte.dev/docs/kit), Svelte 5, and Tailwind CSS. + +## License + +[AGPL-3.0](LICENSE), same as the upstream Photon project.