updated readme

readme.md

···
-# (wip)(not done)(pre alpha) skylite (temporary name probably)(test thing)
-an attempt to make a lightweight, easily self-hostable, scoped appview (kinda like fedi instances, so that means users need to register to an instance to have the content they should see be indexed) using: 
-- live sync systems:
-  - [jetstream](https://github.com/bluesky-social/jetstream)
-  - [spacedust](https://spacedust.microcosm.blue/)
-- backfill:
-  - [listRecords](https://docs.bsky.app/docs/api/com-atproto-repo-list-records)
-  - [constellation](https://constellation.microcosm.blue/)
-- the server stuff:
-  - [sqlite](https://jsr.io/@db/sqlite)
-  - the usage of [typescript](https://www.npmjs.com/package/@atproto/lex-cli)
-  - [deno](https://deno.com/)
+# skylite (pre alpha)
+an attempt to make a lightweight, easily self-hostable, scoped appview
 
-this uses XRPC server tooling and codegen so the repo is kinda large despite not being functional at all
+this project uses: 
+- live sync systems: [jetstream](https://github.com/bluesky-social/jetstream) and [spacedust](https://spacedust.microcosm.blue/)
+- backfill: [listRecords](https://docs.bsky.app/docs/api/com-atproto-repo-list-records) and [constellation](https://constellation.microcosm.blue/)
+- the server stuff: [sqlite](https://jsr.io/@db/sqlite) db, typescript with [codegen](https://www.npmjs.com/package/@atproto/lex-cli), and [deno](https://deno.com/)
 
+## Status
+(as of 25 aug 2025)
 currently the state of the project is:
-- db: 
-  - is not ready but ive started working on it
-  - db schema is kinda there but still iffy on the insertion (kysely with better-sqlite3 or just use raw sql queries with deno jsr:@db/sqlite ?) (or maybe should it not use sqlite at all?)
-- indexing: 
-  - the meta framework of the parsing incoming data is kinda done (good enough for MVP but i would like more indexing provenance)
-  - but the actual logic for index handling to the db is not done
-- registration: 
-  - user registration is not there yet, the wrapper around listRecords exists though (for onboarding/backfill)
-- XRPC Server: 
-  - setup is done, just need to actually implement all 80+ routes
-  - got auth working recently but havent hooked up the validator to the xrpc method/route handler so it can access who requested it
+### Index Server
+- Database: 
+  - Works, though it still needs some more tuning and iteration
+- Registration:
+  - not there yet. currently manually adding users
+  - onboarding backfill is probably next maybe
+- Indexing: 
+  - Jetstream:
+    - its there, i just need to actually handle each and every record type and insert it to the db (like currently 2 out of 12 or so record collections are being inserted into the db)
+  - Spacedust:
+    - its a backlink index so i only needed one table, and so it is complete
+- Server: 
+  - Initial implementation is done
+  - uses per-user instantiaion thing so it can add or remove users as needed
+  - pagination is not a thing yet \:\(
+  - does not implement the Ref / Partial routes yet (currently strips undefineds) (fixing this soon)
+  - also implements the entirety of the Constellation API routes as a bonus (under `/links/`)
+- Lexicon:
+  - unsure about PostViewRef's optional fields
+  - theres 3 remaining profile-related routes thats still not defined yet
+  - some routes need more tweaks
+  - considering adding optional query params to request either skeleton only, partials, or full hydrated (might not be respected by the server though lol)
+  - considering making all of the api routes custom instead of the current situation of having some of the Index server routes be the original unmodified bsky.app routes
 
+### View Server
+- pratically unimplemented
+- currently mostly just proxies api.bsky.app
+- i havent split the DB between the Index server and View server yet
+- hydration (resolving `Ref`s, handling partials) will be implemented soon i think
+- it should (but not yet) have a ranking system to decide which index server to be prioritized if multiple index servers indexes the same user account. (and also should support both api sets (Bluesky AppView API (legacy/fallback) and Bluesky Index Server API ))
 
-there is still a lot of design work i havent done regarding stuff like:
-- moderation
-- indexing provenance
-- registration/unregistration APIs
-- cross instance backfills/viewing
-- also im pretty sure im not listening to all of the app.bsky.* records that i should be listening to but i havent re checked it even though i already imported the entire lexicon directory from the bsky atproto git repo but i just havent checked yet
-- and more
+## Running
+this project is pre-alpha and not intended for general use yet. you are welcome to experiment if you dont mind errors or breaking changes.
+
+the project is split into two, the "Index Server" and the "View Server". 
+these currently run in a single process and share the same HTTP server and port.
+
+configuration is in the `.env` file
+
+expose your localhost to the web using a tunnel or something and use that url as the custom appview url
+
+this should work on any bluesky client that supports changing the appview URL (im using an unreleased custom fork for development)
 
-still very early
-this does not run on any bsky clients yet
-practically none of the api routes have been implemented yet
+there is no way to register users to be indexed by the server yet (either Index nor View servers) so you can just manually add your account to the `system.db` file for now
+
+id say this project is like uhh ~20% done so not a lot of things you can do with this right now