# @gumhq/sdk

> Gum Protocol SDK

Latest version **3.0.1** (published 2023-06-29) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @gumhq/sdk
pnpm add @gumhq/sdk
yarn add @gumhq/sdk
bun add @gumhq/sdk
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2023-06-29 |
| First published | 2023-01-30 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 769.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | shek_dev, vjgpt |

## Links

- npm: https://www.npmjs.com/package/@gumhq/sdk
- npm.io page: https://npm.io/package/@gumhq/sdk

## Dependencies (7)

- [axios](https://npm.io/package/axios.md) ^1.2.6
- [graphql](https://npm.io/package/graphql.md) ^16.6.0
- [js-sha3](https://npm.io/package/js-sha3.md) ^0.8.0
- [tweetnacl](https://npm.io/package/tweetnacl.md) ^1.0.3
- [randombytes](https://npm.io/package/randombytes.md) ^2.1.0
- [graphql-request](https://npm.io/package/graphql-request.md) ^5.1.0
- [@project-serum/anchor](https://npm.io/package/@project-serum/anchor.md) ^0.26.0

## Recent versions

- 3.0.1 (latest) — 2023-06-29
- 3.0.0 — 2023-06-19
- 2.1.0 — 2023-05-11
- 2.0.4 — 2023-04-24
- 2.0.3 — 2023-04-18
- 2.0.2 — 2023-04-05
- 2.0.1 — 2023-03-29
- 2.0.0 — 2023-03-27
- 1.0.14 — 2023-03-09
- 1.0.13 — 2023-03-09
- 1.0.12 — 2023-03-01
- 1.0.11 — 2023-02-23
- 1.0.10 — 2023-02-18
- 1.0.9 — 2023-02-15
- 1.0.8 — 2023-02-14
- … 7 more at https://npm.io/package/@gumhq/sdk/versions

## README

# @gumhq/sdk

<p align="center">
  <img alt="npm" src="https://img.shields.io/npm/v/@gumhq/sdk?color=%23d45bff">
  <img alt="npm" src="https://img.shields.io/npm/dt/@gumhq/sdk?color=%23d45bff">
</p>

## Documentation

- [Overview](https://docs.gum.fun/introduction/overview)
- [Getting Started Guide](https://docs.gum.fun/protocol-overview/quickstart)
- [FAQ](https://docs.gum.fun/introduction/faqs)

You can find the complete documentation for the Gum SDK at https://docs.gum.fun/

## Gum Quickstart

The Gum Quickstart is an excellent starting point for developers aiming to leverage Gum in their Next.js applications. This ready-to-use template not only expedites the setup process, but also includes functional examples and components to facilitate the creation of domain profiles, posts, and more. Check out the [Gum Quickstart](https://github.com/gumhq/gum-quickstart) to get started.

## Example App

Check out the [example app](https://github.com/gumhq/gum-example-app) that uses the Gum SDK to demonstrate its capabilities. The app is a simple React app that showcases the creation of a domain, profile, and posts.

## Contributing

We welcome contributions to improve the SDK. Please raise an issue or submit a pull request with any suggestions or bug fixes.

## License

The Gum SDK is licensed under the [GNU General Public License v3.0](https://github.com/gumhq/sdk/blob/master/LICENSE).

## Support

Join our Discord community at [https://discord.gg/tCswbSK5W2](https://discord.gg/tCswbSK5W2) for any questions or support.

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