@ceramicnetwork/core
TypeScript icon, indicating that this package has built-in type declarations

5.9.0 • Public • Published

Ceramic Core

ceramicnetwork MIT license Twitter

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 '@ceramicnetwork/core'
import TileDocument from '@ceramicnetwork/stream-tile'

import { create as createIPFS } from 'ipfs-core'

const ipfs = createIPFS()

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.

License

/@ceramicnetwork/core/

    Package Sidebar

    Install

    npm i @ceramicnetwork/core

    Weekly Downloads

    1,971

    Version

    5.9.0

    License

    (Apache-2.0 OR MIT)

    Unpacked Size

    573 kB

    Total Files

    302

    Last publish

    Collaborators

    • dav1do
    • ceramic-velvetshark
    • cb3box
    • jpham2023
    • npm.3box
    • smrz2001
    • oed
    • paul_lecam
    • stbrody
    • ukstv