JavaScript Implementation of Git IPLD format
npm install ipld-git⛔️ DEPRECATED: This module is no longer maintained. It can be used with multiformats by wrapping it with ipld-format-to-blockcodec
======
 
> JavaScript implementation of the IPLD spec.
- js-ipld-git
- Lead Maintainer
- Table of Contents
- Install
- npm
- Use in Node.js
- Use in a browser with browserify, webpack or any other bundler
- Use in a browser Using a script tag
- Usage
- Contribute
- License
``sh`
> npm install ipld-git
`JavaScript`
const IpldGit = require('ipld-git')
The code published to npm that gets loaded on require is in fact a ES5 transpiled version with the right shims added. This means that you can require it and use with your favourite bundler without having to adjust asset management process.
`JavaScript`
var IpldGit = require('ipld-git')
Loading this module through a script tag will make the IpldGit obj available in the global namespace.
`html`
`JavaScript
const IpldGit = require('ipld-git')
const zlib = require('zlib')
// gitObject is a Buffer containing a git object``
inflatedObject = zlib.inflateSync(gitObject)
const dagNode = IpldGit.util.deserialize(inflatedObject)
console.log(dagNode)
Feel free to join in. All welcome. Open an issue!
Check out our contributing document for more information on how we work, and about contributing in general. Please be aware that all interactions related to IPLD are subject to the IPFS Code of Conduct.
Small note: If editing the README, please conform to the standard-readme specification.