Skip to content

Commit 3ef43e4

Browse files
avious00zachferland
authored andcommitted
added composedb to build index (#278)
1 parent 295a798 commit 3ef43e4

File tree

2 files changed

+17
-13
lines changed

2 files changed

+17
-13
lines changed

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
with:
1919
python-version: 3.x
2020
- name: Install MkDocs Material Insiders
21-
run: pip install git+https://${INSIDERS_GITHUB_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
21+
run: pip install git+https://${INSIDERS_GITHUB_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@910f9e6e93520e511ba3c5098f2654df58ee7748
2222
- name: Install plugins
2323
run: pip install mkdocs-minify-plugin mkdocs-redirects
2424
- name: Deploy docs

docs/build/index.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,19 @@
44

55
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.
66

7-
## **System requirements**
7+
## **Get Started**
88

99
---
1010

11-
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.
12-
13-
Most packages are exposed as ECMAScript Modules (ESM), which are supported by most modern browsers and recent versions of Node.
14-
15-
When using Node, we recommend version 16 (LTS), as it is the version used for tests in most Ceramic packages.
16-
17-
## **Get started with frameworks**
11+
### [**ComposeDB →**](https://composedb.js.org/)
1812

19-
---
13+
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.
2014

21-
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.
15+
### [**IDX & Self.ID SDK →**](../reference/self-id/index.md)
2216

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

25-
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.
19+
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.
2620

2721
## **Go deeper with clients**
2822

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

3529
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.
30+
31+
## **System requirements**
32+
33+
---
34+
35+
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.
36+
37+
Most packages are exposed as ECMAScript Modules (ESM), which are supported by most modern browsers and recent versions of Node.
38+
39+
When using Node, we recommend version 16 (LTS), as it is the version used for tests in most Ceramic packages.

0 commit comments

Comments
 (0)