-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
43 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,43 @@ | ||
# ts-topology | ||
The official TypeScript implementation of Topology Protocol | ||
<div align="center"> | ||
<img src="https://avatars.githubusercontent.com/u/157637200" height="128"> | ||
<br /> | ||
<h1>The TypeScript implementation of the Topology Protocol</h1> | ||
</div> | ||
|
||
<div align="center"> | ||
|
||
 | ||
[](https://topology-foundation.github.io/ts-topology/) | ||
[](https://github.com/topology-foundation/ts-topology/blob/main/LICENSE) | ||
[](https://github.com/topology-foundation/ts-topology/issues) | ||
[](https://github.com/topology-foundation/ts-topology/pulls) | ||
|
||
[](https://topology.gg) | ||
[](https://github.com/topology-foundation) | ||
[](https://x.com/topology_gg) | ||
[](https://t.me/topologyfrens) | ||
[](https://discord.gg/GUDGzBP5mn) | ||
</div> | ||
|
||
# Overview | ||
|
||
This is the official TypeScript implementation of the Topology Protocol. The Topology Protocol is a local-first decentralized protocol for real-time applications. It introduces a new concept for Conflict-free Replicated Objects (CRO), that are built on top of libp2p and composed of CRDTs. | ||
|
||
# Specifications | ||
|
||
The specifications of the Topology Protocol are shared across different client implementations and can be found in the [specs repository](https://github.com/topology-foundation/specs). Currently the specifications are starting to be written based on this implementation. | ||
|
||
# Packages | ||
|
||
This repository is a monorepo that contains the following packages: | ||
|
||
| Package | Description | | ||
|---------|--------------------------------------------------| | ||
| crdt | CRDT implementations intended to use as builtins | | ||
| network | Network middleware to abstract libp2p | | ||
| node | Topology Node library and CLI | | ||
| object | CRO objects structure implementation | | ||
|
||
# Examples | ||
|
||
All the examples are located in the `examples` directory. Currently, there is only one example, which is a simple canvas where you can paint pixels. You can also look into the [counter-splash](https://github.com/topology-foundation/counter-splash) (demo for EthCC 2024) repository for a more complex example. |