From 1f8b1edb6b8a626450064362f6f988b5fb912db3 Mon Sep 17 00:00:00 2001 From: Kristo Jorgenson Date: Tue, 14 Jan 2025 13:14:29 +0100 Subject: [PATCH] readme --- README.md | 14 +++++++++----- render.yaml | 1 + 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e763330..5b84f65 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ A Typescript service for creating lists based on a Bluesky labeler's labels. The ## Features * Sets up lists on your labelers account based on your label's display name and description. + * Initializes lists with the same name and description as the label in your labelers service record. * Subscribes to your labeler's websocket * Allows starting from `cursor=0` to get all existing labels * Retries the socket on failures @@ -17,6 +18,7 @@ A Typescript service for creating lists based on a Bluesky labeler's labels. The * Has a basic HttpApi: * GET /health * GET /cursor +* Writes logs to both `stdout` and `LOG_FILEPATH` (default: `log.txt`) ## Configuration @@ -85,22 +87,24 @@ pnpm dev - [ ] Add tests - [ ] Allow more sophisticated list configuration + - [ ] Custom list names + - [ ] Custom list descriptions - [ ] Export as a package to integrate into a larger server ## Operations -**Building** +### Building -To build the package: +When run using Bun, you don't need to build this package. Just run the source code directly using Bun. ```sh -pnpm build +pnpm dev ``` -**Testing** +### Testing To test the package: ```sh pnpm test -``` +``` \ No newline at end of file diff --git a/render.yaml b/render.yaml index 3881463..d98578e 100644 --- a/render.yaml +++ b/render.yaml @@ -2,6 +2,7 @@ services: - type: web name: Bluesky Label Watcher runtime: node + region: ohio autoDeploy: false plan: starter envVars: