Files
hub-monorepo/README.md
Shane da Silva 57544ddd88 chore: Remove more references to Hubble (#2582)
## Why is this change needed?

Remove more dangling references.

## Merge Checklist

- [ ] PR title adheres to the [conventional
commits](https://www.conventionalcommits.org/en/v1.0.0/) standard
- [ ] PR has a
[changeset](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#35-adding-changesets)
- [ ] PR has been tagged with a change label(s) (i.e. documentation,
feature, bugfix, or chore)
- [ ] PR includes
[documentation](https://github.com/farcasterxyz/hub-monorepo/blob/main/CONTRIBUTING.md#32-writing-docs)
if necessary.


<!-- start pr-codex -->

---

## PR-Codex overview
This PR focuses on removing certain scripts and updating the `README.md`
to reflect a more concise description of the monorepo, specifically
regarding its contents and structure.

### Detailed summary
- Deleted the following scripts:
  - `scripts/hubble.sh`
  - `scripts/publish-image.sh`
  - `scripts/hubble-bootstrap.sh`
- Updated the `README.md`:
- Changed the description of the monorepo to focus on packages for
Farcaster Hub communication.
- Removed specific details about the `@farcaster/hubble` app and its
documentation.

>  Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`

<!-- end pr-codex -->
2025-05-16 22:12:31 -07:00

1.3 KiB

Hub Monorepo

This monorepo contains packages used to communicate with a Farcaster Hub.

Getting Started

See CONTRIBUTING.md to set up your developer environment and learn about how to contribute.

Code Organization

The repository is a monorepo with a primary application in the /apps/ folder that imports several packages /packages/. It is written primarily in Typescript and uses Yarn to orchestrate tasks and TurboRepo as its build system. Some performance intensive code is written in Rust and compiled with Cargo.

Packages

Package Name Description
@farcaster/shuttle A package that streams Hubble events to Postgres
@farcaster/hub-nodejs A Node.js client library for Hubble
@farcaster/hub-web A Browser client library for Hubble
@farcaster/core Shared code between all packages