diff --git a/README.md b/README.md index d4181eb..cbb42f5 100644 --- a/README.md +++ b/README.md @@ -8,61 +8,32 @@ Farcaster is a protocol for building decentralized social applications. If you w 2. a quick video overview, check out the [video series](https://www.youtube.com/watch?v=vMWjol6xHJ0&list=PL0eq1PLf6eUdm35v_840EGLXkVJDhxhcF) 3. to contribute to the protocol, see the [contributing guidelines](CONTRIBUTING.md) 4. the latest updates, join the [farcaster telegram channel](https://t.me/farcasterxyz) - -## Table of Contents - -- [Farcaster Protocol](#farcaster-protocol) - - [Table of Contents](#table-of-contents) - - [1. Introduction](#1-introduction) - - [1.1 Prior Art](#11-prior-art) - - [1.2 Proposal](#12-proposal) -- [2. Identity](#2-identity) - - [2.1 Farcaster ID's](#21-farcaster-ids) - - [2.2 Farcaster Names](#22-farcaster-names) - - [2.3 Recovery](#23-recovery) -- [3. Delta-Graph](#3-delta-graph) - - [3.1 Synchronization](#31-synchronization) - - [3.2 Ordering](#32-ordering) - - [3.3 Authentication](#33-authentication) - - [3.4 Bounding Graph Size](#34-bounding-graph-size) -- [4. Hubs](#4-hubs) - - [4.1 Synchronization](#41-synchronization) - - [4.1.2 Sync Trie](#412-sync-trie) - - [4.1.2 Diff Sync](#412-diff-sync) - - [4.1.4 Byzantine Tolerance](#414-byzantine-tolerance) -- [5. Applications](#5-applications) -- [6. Upgradeability](#6-upgradeability) - - [6.1 Release Schedule](#61-release-schedule) - - [Protocol Releases](#protocol-releases) - - [Contract Releases](#contract-releases) - - [Hub Releases](#hub-releases) -- [7. Acknowledgements](#7-acknowledgements) -- [8 Appendix A: Proposals](#8-appendix-a-proposals) - [January 2023](#january-2023) - [December 2022](#december-2022) - [November 2022](#november-2022) - [October 2022](#october-2022) -- [9. Appendix B: Delta Specifications](#9-appendix-b-delta-specifications) - - [9.1 Signed Messages](#91-signed-messages) - - [9.1.1 Message Object](#911-message-object) - - [9.1.2 Message Data](#912-message-data) - - [Timestamps](#timestamps) - - [Network](#network) - - [9.1.3 Message Types](#913-message-types) - - [9.1.4 Storage](#914-storage) - - [Ordering](#ordering) - - [9.2 Signers](#92-signers) - - [9.3 Casts](#93-casts) - - [Mentions](#mentions) - - [Replies](#replies) - - [Store](#store) - - [9.4 Reactions](#94-reactions) - - [Store](#store-1) - - [9.5 Amps](#95-amps) - - [Store](#store-2) - - [9.6 Verifications](#96-verifications) - - [9.6.1 Verification Messages](#961-verification-messages) - - [Store](#store-3) - - [9.7 User Data](#97-user-data) - - [9.7.3 User Data Store](#973-user-data-store) -- [10. Appendix C: Application Specifications](#10-appendix-c-application-specifications) - [Rendering Casts](#rendering-casts) -- [11. Appendix D: Contract Specifications](#11-appendix-d-contract-specifications) - [Username Policy](#username-policy) + + +1. [Introduction](#1-introduction) + 1. [Prior Art](#11-prior-art) + 2. [Proposal](#12-proposal) +2. [Identity](#2-identity) + 1. [Farcaster ID's](#21-farcaster-ids) + 2. [Farcaster Names ](#22-farcaster-names) + 3. [Recovery](#23-recovery) +3. [Delta Graph](#3-delta-graph) + 1. [Synchronization](#31-synchronization) + 2. [Ordering](#32-ordering) + 3. [Authentication](#33-authentication) + 4. [Bounding Graph Size](#34-bounding-graph-size) +4. [Hubs](#4-hubs) + 1. [Synchronization](#41-synchronization) +5. [Applications](#5-applications) +6. [Upgradeability](#6-upgradeability) + 1. [Release Schedule](#61-release-schedule) +7. [Acknowledgements](#7-acknowledgements) +8. [Appendix A: Proposals](#8-appendix-a-proposals) +9. [Appendix B: Delta Specifications](#9-appendix-b-delta-specifications) +10. [Appendix C: Application Specifications](#10-appendix-c-application-specifications) +11. [Appendix D: Contract Specifications](#11-appendix-d-contract-specifications) ## 1. Introduction