Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kristojorg committed Jan 14, 2025
1 parent 2275fe6 commit 1f8b1ed
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down Expand Up @@ -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
```
```
1 change: 1 addition & 0 deletions render.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ services:
- type: web
name: Bluesky Label Watcher
runtime: node
region: ohio
autoDeploy: false
plan: starter
envVars:
Expand Down

0 comments on commit 1f8b1ed

Please sign in to comment.