# README

grpc-ipfs-lite

A gRPC wrapper around ipfs-lite

IPFS-lite Libraries

The following includes information about support for ipfs-lite.

Name	Build	Language	Description
`ipfs-lite`			The reference implementaiton of ipfs-lite, written in Go.
`js-ipfs-lite`			The Javascript version of ipfs-lite available for web, nodejs, and React Native applications.
`ios-ipfs-lite`			The iOS ipfs-lite library for use in Objc and Swift apps
`android-ipfs-lite`			The Java ipfs-lite library for us in Android apps
`grpc-ipfs-lite`			A common gRPC API interface that runs on the Go ipfs-lite node.

What is IPFS Lite?

From the ipfs-lite project:

IPFS-Lite is an embeddable, lightweight IPFS peer which runs the minimal setup to provide an ipld.DAGService. It can:

Add, Get, Remove IPLD Nodes to/from the IPFS Network (remove is a local blockstore operation).
Add single files (chunk, build the DAG and Add) from a io.Reader.
Get single files given a their CID.

It provides:

An ipld.DAGService
An AddFile method to add content from a reader
A GetFile method to get a file from IPFS.

What is the gRPC wrapper?

gRPC is a modern open source high performance RPC framework that can run in any environment.

This project adds a minimal gRPC service on top of the IPFS Lite module. It allows you to embed IPFS Lite into multiple projects while exposing a common API. You could deploy IPFS Lite as a microservice, embed it in mobile applications, or wrap it in a Dockerfile.