max / synckit
git clone https://makenot.work/git/max/synckit.git
git clone git@ssh.makenot.work:max/synckit.git
| Name | Size | |
|---|---|---|
| scripts/ | ||
| synckit-client/ | ||
| synckit-config/ | ||
| .gitignore | 490 B | |
| CLA.md | 6.4 KB | |
| CONTRIBUTING.md | 6.5 KB | |
| LICENSE | 1.0 KB | |
| README.md | 2.4 KB | |
| rust-toolchain.toml | 523 B |
README
synckit
End-to-end-encrypted sync: the client SDK and the local config store.
Two standalone crates, no root workspace; each builds on its own, matching the ecosystem convention.
synckit-client, the sync SDK: transport, crypto, the declarativeSyncStoreengine over SQLite. Internal; consumed by path or git dependency, never published to crates.io.synckit-config, a local key/value settings store with per-key sync postures. The store half of portable config; usable with no network, so a no-sync consumer (a TUI remembering a theme) links it without the SDK. The sync adapter that turns aConfigSpecinto aSyncTablelives insynckit-clientbehind itsstorefeature.
Working on the code: CONTRIBUTING.md covers the crate boundary, the feature
flags, how to run each test configuration, and the test conventions.
License
MIT, both crates. Integrating SyncKit into an application carries no condition on what that application charges for.
The restriction is on hosting, and it is not in this repo. The sync server lives in the MNW server under PolyForm Noncommercial 1.0.0: run one for noncommercial purposes freely, but selling hosting on it needs a different arrangement. Pairing this SDK with a server you wrote yourself is outside that perimeter and fine.
Contributing
This project is licensed under MIT. Make Creative, LLC owns the codebase and needs to hold clear title to all of it, so contributions still work a little differently here than on most permissively licensed projects.
Found a bug, or something small and obviously wrong? Open a bug report rather than sending a patch. A clear report of what you did, what happened, and what you expected is worth more to us than a diff, and it saves you the paperwork below.
Want to build something substantial? Write to info@makenot.work first. We are open to paying for contributions that matter, and we would rather agree on scope and terms before you spend your evenings on it than after.
Sending code directly? Any code you submit is covered by the Contributor License
Agreement in CLA.md, which assigns copyright in the contribution to Make Creative,
LLC. Read it before you send anything. Add these lines to your commit message to
record that you accept it:
Make-Creative-CLA: 1.0.0
Signed-off-by: Your Name <your@email>
We may decline a contribution for any reason, including that it is not something we want to maintain.