rvagg/js-ceramic

Typescript implementation of the Ceramic protocol

js-ceramic

js-ceramic is a monorepo containing the TypeScript implementation of the Ceramic protocol. If you are unfamiliar with Ceramic, see the website or overview for more information.

Project status: Clay testnet is now live. 🚀
Clay is a decentralized public network ready for experimental application development and testing. It anchors documents on the Ethereum Ropsten and Rinkeby testnets. It is the last major milestone before Fire mainnet, which is under development and will launch in late Q1 2021. Documents published on Clay will not be portable to Fire.

Clients

js-ceramic provides three JavaScript clients that offer different ways to interact with the Ceramic network.

Client	Package	Description	Current Version
Core	@ceramicnetwork/core	Full JavaScript protocol implementation
CLI	@ceramicnetwork/cli	CLI and HTTP daemon
HTTP	@ceramicnetwork/http-client	HTTP client that can interact with a remote Ceramic daemon

For performance reasons it is recommended that you use the HTTP client if you are building an application.

Quick start

Learn the basics by setting up and interacting with the Ceramic CLI. Quick start guide →

Installation and usage

Full documentation on installation and usage can be found on the Ceramic documentation site →

Troubleshooting

• For questions, support, and discussions: Join the Ceramic Discord
• For bugs and feature requests: Create an issue on Github

Contributing

We are happy to accept small and large contributions, feel free to make a suggestion or submit a pull request.

Check out the Development section to learn how to navigate the code in this repo.

Maintainers

• Spencer (@stbrody)

License

Fully open source and dual-licensed under MIT and Apache 2.