# @ceramicstudio/idx

> JavaScript/TypeScript implementation of the [IDX protocol](https://idx.xyz).

Latest version **0.12.2** (published 2021-09-09) · (Apache-2.0 OR MIT) license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @ceramicstudio/idx
pnpm add @ceramicstudio/idx
yarn add @ceramicstudio/idx
bun add @ceramicstudio/idx
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.12.2 |
| Published | 2021-09-09 |
| First published | 2020-09-15 |
| Weekly downloads | 0 |
| License | (Apache-2.0 OR MIT) |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=12 |
| Dependencies | 5 |
| Unpacked size | 401.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ceramic Studio |
| Maintainers | paul_lecam, oed, zachferland, ukstv |

## Links

- npm: https://www.npmjs.com/package/@ceramicstudio/idx
- Homepage: https://idx.xyz
- npm.io page: https://npm.io/package/@ceramicstudio/idx

## Dependencies (5)

- [caip](https://npm.io/package/caip.md) ^0.9.2
- [cross-fetch](https://npm.io/package/cross-fetch.md) ^3.1.4
- [@ceramicnetwork/stream-tile](https://npm.io/package/@ceramicnetwork/stream-tile.md) ^1.0.0
- [@ceramicstudio/idx-constants](https://npm.io/package/@ceramicstudio/idx-constants.md) ^1.0.0
- [@ceramicnetwork/stream-caip10-link](https://npm.io/package/@ceramicnetwork/stream-caip10-link.md) ^1.0.0

## Recent versions

- 0.12.2 (latest) — 2021-09-09
- 0.11.0-rc.0 (next) — 2021-04-29
- 0.12.1 — 2021-06-01
- 0.12.0 — 2021-05-19
- 0.11.0 — 2021-05-06
- 0.10.0 — 2021-04-13
- 0.9.1 — 2021-04-06
- 0.9.0 — 2021-03-24
- 0.8.0 — 2021-02-22
- 0.7.0 — 2021-01-19
- 0.6.0 — 2021-01-14
- 0.5.2 — 2020-12-28
- 0.5.2-beta.1 — 2020-12-25
- 0.5.1 — 2020-12-23
- 0.5.0 — 2020-12-17
- … 7 more at https://npm.io/package/@ceramicstudio/idx/versions

## README

# js-idx

JavaScript/TypeScript implementation of the [IDX protocol](https://idx.xyz).

> ⚠️ IDX is in alpha. Libraries may be unstable and APIs are subject to change.

## IDX: An identity protocol for open applications

IDX is a cross-platform identity protocol that replaces centralized user tables with a decentralized alternative. IDX allows users to build up a unified digital identity consisting of all their data while enabling developers to break down silos and freely share a users' data between applications. IDX supports all application architectures, but is notably compatible with all blockchains, wallets, and user/application datastores.

- **Eliminate users from your server**: Replace centralized user IDs and user tables with a secure decentralized alternative
- **Connect many accounts**: Link multiple blockchain, web3, social network accounts, and domains to the same user identity
- **Use any datastore**: Store user and application data in any DB server, blockchain, or Web3 datastore
- **Make your data discoverable**: Add references to your data to a user’s personal index, where it can be discovered by others
- **Import data from other apps**: Discover a user's entire catalog of data by querying the index and import it into your app
- **Give users control**: Give users control over data discovery, sharing, and permissions

## Getting started

- [Quick start](https://developers.idx.xyz/build/quick-start)
- [Installation](https://developers.idx.xyz/build/installation)

## More resources

- [Learn the basics](https://developers.idx.xyz/learn/welcome)
- [API Reference](https://developers.idx.xyz/reference/idx)
- [Developer chat](https://chat.idx.xyz)

## Maintainers

- Paul Le Cam ([@paullecam](http://github.com/paullecam))

## License

Dual licensed under MIT and Apache 2

---
_Source: https://npm.io/package/@ceramicstudio/idx · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._