- Mercury Core
- Installation
- NPM package
- Generating documentation
- Examples.
- License
- Contact
- Additional Resources
Mercury Core is a Network and Storage manager for the Mercury Note App . This repository provides the core functionality that powers Mercury’s decentralized storage and networking capabilities.
Features
- Network Management: Handling of peer-to-peer connections.
- Storage Management: Use hyperbee and autobase for data storage.
To get started, clone this repository and install the dependencies:
git clone https://github.com/nexhero/mercury-core.git
cd mercury-core
npm install
npm i mercury-core
jsdoc -c jsdoc.json
open docs/index.html
A Corestore is required for mercury to save documents.
const store = new Corestore('./temp_store.db');
const mercury = new Mercury(store);
await mercury.initialize(); //wait until storage is ready
mercury.listen(); //Listen for connections
const channel = mercury.encodeRepository();
console.log('Repository channel:',channel);
mercury.joinRemoteRepository(channel,'desktop')
.then((msg)=>console.log(msg))
.catch((err)=>console.log(`Unable to append repository ${String(err)}`))
const id = 'abc';
mercury.removeRepository(id)
.then(()=>console.log('Repository has been removed'))
.catch((err)=>console.log(`Unable to remove repository ${String(err)}`));
const doc = mercury.createDocument('BASE');
doc.setLabel('This is a document');
doc.setContent('<p>Hello world</p>');
doc.save()
mercury.db.getAllDocuments();
mercury.db.getDocument(id);
mercury.db.removeDocument(id);
This project is licensed under the MIT License
For questions or support, reach out to the repository maintainers via GitHub Issues.