waku.guide/docs/sdk/index.md

44 lines
2.3 KiB
Markdown
Raw Normal View History

2023-05-23 11:50:55 +00:00
---
title: Getting Started With Waku
2023-05-23 11:50:55 +00:00
slug: /sdk/overview
---
:::caution
Waku has risks and limitations as it is still developing and preparing for extensive adoption. However, it is already demonstrating its capabilities by [powering various applications](/powered-by-waku). [Join our community](/community) to stay updated on our progress.
2023-05-23 11:50:55 +00:00
:::
Ready to integrate Waku into your application for private, secure, censorship-free communication? Explore the available integration options and contribute by operating a node.
2023-05-23 11:50:55 +00:00
## Operating a Waku Node
2023-05-23 11:50:55 +00:00
The Waku network is permissionless and decentralized, consisting of nodes. It is open for anyone to operate a node, use the network, and contribute to its support. Please visit the [nwaku guide for operators](https://github.com/waku-org/nwaku/tree/master/docs/operators) to learn more.
2023-05-23 11:50:55 +00:00
## SDK Integrations
2023-05-23 11:50:55 +00:00
| SDK | Description | Documentation |
| - | - | - |
| [nwaku](https://github.com/waku-org/nwaku) | Nim SDK recommended for operating a node and interacting with Waku | |
2023-05-23 11:50:55 +00:00
| [js-waku](https://github.com/waku-org/js-waku) | JavaScript/TypeScript SDK designed for browser environments | |
| [go-waku](https://github.com/waku-org/go-waku) | Golang SDK designed for integration in Golang applications, includes C bindings for usage in C/C++, C#/Unity, Swift, and Kotlin | |
| [waku-rust-bindings](https://github.com/waku-org/waku-rust-bindings) | Rust wrapper using `go-waku` bindings designed for integration in Rust applications | |
2023-05-23 11:50:55 +00:00
## API Integration
| API Protocol | Description | Documentation |
| - | - | - |
2023-05-24 17:29:24 +00:00
| JSON-RPC | `JSON-RPC` API provided by nodes for seamless integration with Waku | |
2023-05-23 11:50:55 +00:00
## Mobile Integrations
2023-05-23 11:50:55 +00:00
| Language | Description | Documentation |
| - | - | - |
| React Native | React Native wrapper using `go-waku` bindings designed for native mobile integration | |
| Swift (iOS) | Swift applications can use `go-waku` bindings to seamlessly integrate Waku | |
| Kotlin (Android) | Kotlin applications can use `go-waku` bindings to seamlessly integrate Waku | |
## Other Integrations
| SDK | Description | Documentation |
| - | - | - |
| [waku-ui](https://github.com/waku-org/waku-ui) | React components and UI adapters designed for seamless integration with `js-waku` | |
| [@waku/create-app](https://www.npmjs.com/package/@waku/create-app) | Starter kit to bootstrap your next Waku project from various example templates | |