Ceramic Core
This package contains the implementation of the core Ceramic protocol. It's exposed using a simple JavaScript API.
Getting started
Installation
$ npm install @ceramicnetwork/core
Usage
See the Ceramic developer site for more details about how to use this package.
import Ceramic from '@dustil/core'
import TileDocument from '@dustil/stream-tile'
import { create as createIPFS } from 'ipfs-core'
import * as dagJose from 'dag-jose'
const ipfs = createIPFS({
ipld: { codecs: [dagJose] },
})
const config: CeramicConfig = {}
const ceramic = await Ceramic.create(ipfs, config)
// create document example
const tileDocument = await TileDocument.create(ceramic, { test: 123 })
Ceramic API
Complete Ceramic core API is available on Ceramic API.
Development
Run tests:
$ npm test
Run linter:
npm run lint
Contributing
We are happy to accept small and large contributions. Make sure to check out the Ceramic specifications for details of how the protocol works.