ubisync/README.md

# ubisync
This repo provides arbitrary data synchronization via I2P.

## Goals
- [ ] Core library for delta-syncing data via I2P
- [ ] Simple multi-platform GUI for setup and administration of one's ubisync node
- [ ] API for other software running on the same machine, providing sync of their data

## Vision
- Tag-based and full-text search across all data of the node
- Expose common data types found in any application's data store to the API
    - recognize to-dos or dates in any data and expose them
    - expose all data linked to any given time interval (e.g. files changed and messages sent on a given day)
    - ...
- Allow easy-to-set-up passive nodes which clone all data of the active nodes, essentially replacing data sync servers and serving as sovereign backup solution

# Structure of this repository
This repository contains all crates necessary for ubisync:
- `ubisync` builds the binary of a ubisync node which can be run by users to take part in the ubisync network
- `ubisync-lib` builds a library with all common type definitions, utilities etc.
- `ubisync-sdk` builds a library for app developers, including a wrapper for the API
Proof of Concept 2023-12-07 19:51:19 +01:00			`# ubisync`
			`This repo provides arbitrary data synchronization via I2P.`

			`## Goals`
			`- [ ] Core library for delta-syncing data via I2P`
			`- [ ] Simple multi-platform GUI for setup and administration of one's ubisync node`
			`- [ ] API for other software running on the same machine, providing sync of their data`

			`## Vision`
			`- Tag-based and full-text search across all data of the node`
			`- Expose common data types found in any application's data store to the API`
			`- recognize to-dos or dates in any data and expose them`
			`- expose all data linked to any given time interval (e.g. files changed and messages sent on a given day)`
			`- ...`
Split repository into 3 crates 2024-01-05 20:59:25 +01:00			`- Allow easy-to-set-up passive nodes which clone all data of the active nodes, essentially replacing data sync servers and serving as sovereign backup solution`

			`# Structure of this repository`
			`This repository contains all crates necessary for ubisync:`
			- `ubisync` builds the binary of a ubisync node which can be run by users to take part in the ubisync network
			- `ubisync-lib` builds a library with all common type definitions, utilities etc.
			- `ubisync-sdk` builds a library for app developers, including a wrapper for the API