diff --git a/README.md b/README.md index 10364c6..52cffd9 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,14 @@ # PDSls - Atmosphere Explorer -Lightweight and client-side web app to navigate [atproto](https://atproto.com/). - -## Features - -- Browse the public data on PDSes (Personal Data Servers). -- Login to manage records in your repository. -- Jetstream and firehose (com.atproto.sync.subscribeRepos) streaming. -- Backlinks support with [constellation](https://constellation.microcosm.blue/). -- Query moderation labels. -- Explore and unpack repository archives (CAR). +Lightweight web app to navigate [atproto](https://atproto.com/). ## Hacking You will need `node` and `pnpm` to get started: ``` -pnpm i # install deps -pnpm dev # or pnpm run start, runs vite -pnpm build # runs vite build -pnpm serve # runs vite preview +pnpm i # install deps +pnpm dev # runs local dev server +pnpm build # bundles the production app +pnpx wrangler pages dev # runs worker locally ``` - -## Credits - -[atcute](https://github.com/mary-ext/atcute) - atproto SDK\ -[@skyware/firehose](https://github.com/skyware-js/firehose) - Firehose client