syncpad

THIS PROJECT IS STILL IN THE DESIGN PHASE

IDEAS & CONTRIBUTIONS ARE WELCOME

An Open Source Universe Project

---

Contents

• syncpad
  • Contents
  • Features ✨
  • Install 🛠
  • Usage 🔭
  • Documentation 🛰
  • Contributing 🌎
  • License ⚖️

Features ✨

• Create a Syncpad Config Grid Planned
• Load Config into BigParser Planned
• Sync Config from BigParser Planned
• Sync Config in Realtime Planned
• Typescript Support Planned

Install 🛠

npm install syncpad

Usage 🔭

Read more about the Design behind syncpad here.

$ syncpad create
Creating a Syncpad Grid in your BigParser Account...
Congrats! Your Syncpad Grid is ready for use!

$ syncpad load
Loading your Config into BigParser...
Congrats! Your Config is Ready to Sync!

$ syncpad sync
Syncing Config from BigParser into this project...
Sync Complete! Your Project Config is now up-to-date

$ syncpad daemon
Starting Background Daemon to Sync Projects...
Daemon Started! Your Projects will be syncing in realtime.

Documentation 🛰

syncpad is under active development, documentation will be added once an initial release is ready.

Contributing 🌎

We would love for you to contribute your ideas, code, & fixes to syncpad.

We encourage everyone to read our Design Document to learn more about the thought process behind syncpad.

Also check out the rewards offered for contributing to the Open Source Universe.

License ⚖️

MIT