https://github.com/farcasterxyz/protocol

Specification of the Farcaster Protocol
https://github.com/farcasterxyz/protocol

farcaster

Last synced: 1 day ago
JSON representation

Specification of the Farcaster Protocol

• Host: GitHub
• URL: https://github.com/farcasterxyz/protocol
• Owner: farcasterxyz
• Created: 2022-05-13T01:53:11.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-11T17:29:40.000Z (2 months ago)
• Last Synced: 2025-02-13T08:02:46.622Z (8 days ago)
• Topics: farcaster
• Homepage: http://farcaster.xyz
• Size: 764 KB
• Stars: 2,056
• Watchers: 58
• Forks: 287
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

• awesome - farcasterxyz/protocol - Specification of the Farcaster Protocol (miscellaneous)
• awesome-farcaster - farcasterxyz/protocol

README

        
# Farcaster Protocol

![Archway](/images/arch512.png)

## Getting Started

Farcaster is a protocol for building decentralized social apps. This repository contains the technical specifications for implementing Farcaster.

If you are instead looking for:

1. How to get started, check out [farcaster.xyz](https://www.farcaster.xyz).

2. Developer documentation, check out [docs.farcaster.xyz](https://docs.farcaster.xyz).

## Specifications

The specification is maintained as a Markdown file. There are three important sections:

1. [Overview](/docs/OVERVIEW.md) - A high level overview of the protocol.

2. [Specification](/docs/SPECIFICATION.md) - The technical spec for implementing Farcaster.

3. [FIP Discussions](https://github.com/farcasterxyz/protocol/discussions) - A forum where new proposals to change the specification are discussed.

## Contributing

To make contributions to the protocol, please see the [contributing guidelines](CONTRIBUTING.md)