README.yml

name: DXOS
install: false
description: |
  A decentralized alternative to the commercial cloud for privacy preserving software. Learn more about the [the mission](https://docs.dxos.org/guide/why)
badges:
  - '[![MIT License](https://img.shields.io/npm/l/@dxos/client)](https://github.com/dxos/dxos/blob/main/LICENSE)'
  - '[![CI](https://img.shields.io/circleci/build/gh/dxos/dxos/main?style=flat&token=dfa4d4d2d6b8a794bcb5f5772096beb2006cdfa8)](https://circleci.com/gh/dxos/dxos)'
  - '![Netlify Status](https://img.shields.io/netlify/847d26d2-ec3b-4f2e-ac3b-caee7fe6e7bc)'
  - '[![codecov](https://img.shields.io/codecov/c/github/dxos/dxos?token=CLO9PHX2PQ)](https://codecov.io/gh/dxos/dxos)'
  - '![Node](https://img.shields.io/node/v/@dxos/client)'
  - '[![NPM](https://img.shields.io/npm/v/@dxos/client/latest)](https://www.npmjs.com/package/@dxos/client)'
  - '[![Discord](https://img.shields.io/discord/837138313172353095?label=discord)](https://discord.com/channels/837138313172353095)'
  - '[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/dxos_org.svg?style=social&label=Follow%20%40DXOS)](https://twitter.com/dxos_org)'

  # - '![Activity](https://img.shields.io/github/commit-activity/m/dxos/dxos)'
  # - '![Contributors](https://img.shields.io/github/contributors/dxos/dxos)'

banner: '![DXOS](./docs/content/assets/images/github-repo-banner.png)'
quickStartUrl: https://docs.dxos.org/guide/quick-start
guideUrl: https://docs.dxos.org/guide
apiReferenceUrl: https://docs.dxos.org/api
demo: |
  Shown below are two sessions of an application using ECHO to replicate state peer-to-peer in real-time.

  ![ECHO](https://user-images.githubusercontent.com/3523355/158708286-f9a8c5f1-83ed-4bac-ab9e-65ddb6861fe3.gif)
coverageDiagram: '![Coverage](https://codecov.io/gh/dxos/dxos/branch/main/graphs/tree.svg?token=CLO9PHX2PQ)'
repoGuideUrl: 'https://github.com/dxos/dxos/tree/main/REPOSITORY_GUIDE.md'