Skip to content

README.md

Latest commit

 

History

History
143 lines (81 loc) · 3.14 KB

README.md

File metadata and controls

143 lines (81 loc) · 3.14 KB
Raw

Table of Contents

  1. Mercury Core
  2. Installation
  3. NPM package
  4. Generating documentation
  5. Examples.
    1. Initialize Database
    2. Share local repository
    3. Append other repository
    4. Remove repository
    5. Create Document
    6. CRUD.
  6. License
  7. Contact
  8. Additional Resources

Mercury Core

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.

Installation

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 package

npm i mercury-core

Generating documentation

jsdoc -c jsdoc.json
open docs/index.html

Examples.

Initialize Database

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

Share local repository

const channel = mercury.encodeRepository();
console.log('Repository channel:',channel);

Append other repository

mercury.joinRemoteRepository(channel,'desktop')
    .then((msg)=>console.log(msg))
    .catch((err)=>console.log(`Unable to append repository ${String(err)}`))

Remove repository

const id = 'abc';
mercury.removeRepository(id)
    .then(()=>console.log('Repository has been removed'))
    .catch((err)=>console.log(`Unable to remove repository ${String(err)}`));

Create Document

const doc = mercury.createDocument('BASE');
doc.setLabel('This is a document');
doc.setContent('<p>Hello world</p>');
doc.save()

CRUD.

mercury.db.getAllDocuments();
mercury.db.getDocument(id);
mercury.db.removeDocument(id);

License

This project is licensed under the MIT License

Contact

For questions or support, reach out to the repository maintainers via GitHub Issues.

Additional Resources