Skip to content

Latest commit

 

History

History
158 lines (107 loc) · 4.98 KB

README.md

File metadata and controls

158 lines (107 loc) · 4.98 KB
Raw

Borg Client

The Borg library abstracts away the protocols and `libp2p` connection, and exposes APIs similar to MongoDB for data persistence and S3 for file storage

Built With

(back to top)

Getting Started

Use Server with caution and know the risk's because we are at development stage and the identity and encryption is not available, so you become public node that can accessed from anywhere.

Installation

Install NPM package

npm install @functionland/borg --save

or using CDN

<script src="https://cdn.jsdelivr.net/npm/@functionland/borg/dist/index.js"></script>

(back to top)

Usage

Start borg and use file storage of borg-server

 import {Borg, createClient} from '@functionland/borg'

 // Create a borg client 
 const borgClient = await createClient();
 // ...
 // connect to a borg server by its base58 string PeerId
 await borgClient.connect(serverId)
 // send file and get cid
 // selectedFile send file use StreamReader interface or AsyncItrable and get cid
 // meta {name,type,lastModified,size}
 const FileCid = await borgClient.sendStreamFile(selectedFile,meta);
 // recive meta data 
 const data = await borgClient.receiveMeta(fileId);
 // recive file using cid
 const data = await borgClient.receiveFile(FileCid);
 let reader = new FileReader();
 reader.readAsDataURL(data);
 reader.onloadend = (e) => setContent(reader.result)

For more examples, please refer to the Examples

(back to top)

Roadmap

  • Protocols
    • File
    • Data
    • AI
  • Identity
  • Encryption

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

See LICENSE for more information.

(back to top)