justincpresley/ndn-sync

![Visual](/docs/README_VISUAL.png) [![Test](https://img.shields.io/github/actions/workflow/status/justincpresley/ndn-sync/test.yaml?branch=production&label=Test)][1] [![CodeQL](https://img.shields.io/github/actions/workflow/status/justincpresley/ndn-sync/codeql.yml?branch=production&label=CodeQL)][2] [![CodeFactor](https://img.shields.io/codefactor/grade/github/justincpresley/ndn-sync/production?label=CodeFactor)][3] [![Language](https://img.shields.io/github/go-mod/go-version/justincpresley/ndn-sync/production?label=Go)][4] [![Version](https://img.shields.io/github/v/tag/justincpresley/ndn-sync?label=Latest%20version)][5] [![Commits](https://img.shields.io/github/commits-since/justincpresley/ndn-sync/latest/production?label=Unreleased%20commits)][6] [![License](https://img.shields.io/github/license/justincpresley/ndn-sync?label=License)][7]

ndn-sync is a Go library implementing Named Data Networking (NDN) Distributed Dataset Synchronization 'Sync' Protocols that can be used to write various real-time NDN Applications.

The goal of 'Sync' is to inform others about updates in a dataset and/or to learn about newly published data, effectively synchronizing data in a group. ndn-sync welcomes both newcomers and experts of NDN.

ndn-sync is implemented using the NDN library go-ndn.

Branches

ndn-sync contains two main branches with their differences described below:

production: The master branch which holds Syncs along with any modifications to make them more stable/usable for applications. This branch is actively being served as a Go package.
specification: The side branch which holds Syncs in their original form according to their technical specification.

Usage

Before you utilize ndn-sync or try any of its examples, please ensure that you have the necessary prerequisites. It will take but a few minutes!

ndn-sync is a library containing multiple modules (different Syncs), each with individual functionality and use.

It is highly recommended that you check out the examples. Sometimes, seeing the Syncs in action can give you ideas and help you in understanding what the Syncs provide.

Syncs

There are many Syncs!

Ones that are being used in applications, others that are currently experiments, and some that have yet to be discovered. ndn-sync gladly accepts any kind of Sync protocol with a slight bias towards new and/or stable Syncs.

This Sync Survey describes many of the Syncs that are currently known and their unique differences. It is a recommended read.

ndn-sync has the following Syncs implemented:

svs - StateVectorSync: Details | API Documentation | Examples

Contribution

The most effortless way you can contribute to ndn-sync is to simply have discussions surrounding ndn-sync.

In addition, ndn-sync has more practical ways to get involved: Issues and Pull Requests.

License

ndn-sync is an open source project licensed under ISC. See LICENSE.md for more information.