Skip to content

Commit

Permalink
added composedb to build index (#278)
Browse files Browse the repository at this point in the history
  • Loading branch information
avious00 authored and zachferland committed Feb 10, 2023
1 parent 295a798 commit 3ef43e4
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
with:
python-version: 3.x
- name: Install MkDocs Material Insiders
run: pip install git+https://${INSIDERS_GITHUB_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
run: pip install git+https://${INSIDERS_GITHUB_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@910f9e6e93520e511ba3c5098f2654df58ee7748
- name: Install plugins
run: pip install mkdocs-minify-plugin mkdocs-redirects
- name: Deploy docs
Expand Down
28 changes: 16 additions & 12 deletions docs/build/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,19 @@

Ceramic provides a decentralized network for building Web3 applications with composable data. Ceramic's APIs enable applications to store, modify, and retrieve data from a scalable decentralized data network, while maintaining composability of data across applications.

## **System requirements**
## **Get Started**

---

Ceramic clients and tools using them are designed for environments supporting [ECMAScript 11th edition](https://262.ecma-international.org/11.0/), commonly referred to as ES2020.

Most packages are exposed as ECMAScript Modules (ESM), which are supported by most modern browsers and recent versions of Node.

When using Node, we recommend version 16 (LTS), as it is the version used for tests in most Ceramic packages.

## **Get started with frameworks**
### [**ComposeDB →**](https://composedb.js.org/)

---
ComposeDB is the latest and greatest way to build apps on Ceramic's data layer. It is a decentralized, verifiable graph DB and supports both Javascript and GraphQL.

Frameworks make it easy to build applications on Ceramic by abstracting away much of the complexity and configuration of the underlying [Ceramic stack](the-ceramic-stack.md), providing developers with a simple entrypoint into Ceramic development. If you're new to Ceramic, or even if you're experienced, this is the place to start.
### [**IDX & Self.ID SDK →**](../reference/self-id/index.md)

### [**Self.ID SDK →**](../reference/self-id/index.md)
A legacy alternative to ComposeDB is IDX, a key-value store DB, also built on Ceramic.

Self.ID is a framework for building Ceramic applications with composable, user-centric data. In addition to including a full Ceramic setup for a variety of development environments, Self.ID allows users to authenticate with their existing blockchain wallets and also includes some of the most popular data models giving you out of the box composability with a rich set of data on the network to bootstrap your application.
Self.ID is a framework for building applications for IDX on Ceramic. In addition to including a full Ceramic setup for a variety of development environments, The Self.ID SDK allows users to authenticate with their existing blockchain wallets and also includes some of the most popular data models giving you out of the box composability with a rich set of data on the network to bootstrap your application.

## **Go deeper with clients**

Expand All @@ -33,3 +27,13 @@ Clients are a lower-level way to connect your application to the Ceramic network
### [**JavaScript HTTP client →**](../reference/core-clients/ceramic-http.md)

The Ceramic JS HTTP client is a Ceramic client that can be used in browsers and Node.js environments to connect your application to a Ceramic node. This is the recommended Ceramic client to build with for most applications, if you're not using a framework.

## **System requirements**

---

Ceramic clients and tools using them are designed for environments supporting [ECMAScript 11th edition](https://262.ecma-international.org/11.0/), commonly referred to as ES2020.

Most packages are exposed as ECMAScript Modules (ESM), which are supported by most modern browsers and recent versions of Node.

When using Node, we recommend version 16 (LTS), as it is the version used for tests in most Ceramic packages.

0 comments on commit 3ef43e4

Please sign in to comment.