Skip to content

Commit

Permalink
📝 Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GabrielePicco committed Oct 9, 2023
1 parent d1c0d57 commit 5046aee
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 18 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,15 @@ npx lerna run build

| Name | Description | Version |
| --------------------------------------------------------------------------------- | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------- |
| [`@gumhq/sdk`](https://github.com/magicblock-labs/gum-sdk/tree/master/packages/gpl-core) | Typescript client to interact with Gum protocol. | <p align="center"><img alt="npm" src="https://img.shields.io/npm/v/@magicblock-labs/gum-sdk?color=%23d45bff"></p> |
| [`@gumhq/react-sdk`](https://github.com/magicblock-labs/gum-sdk/tree/master/packages/react-sdk) | React Hooks for Gum protocol | <p align="center"><img alt="npm" src="https://img.shields.io/npm/v/@magicblock-labs/gum-react-sdk?color=%23d45bff"></p> |
| [`@magicblock-labs/gum-sdk`](https://github.com/magicblock-labs/gum-sdk/tree/master/packages/gpl-core) | Typescript client to interact with Gum protocol. | <p align="center"><img alt="npm" src="https://img.shields.io/npm/v/@magicblock-labs/gum-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/
You can find the complete documentation for the Gum SDK at https://docs.magicblock.gg/Onboarding/Session%20Keys/introduction

## Gum Quickstart

Expand All @@ -60,4 +59,4 @@ The Gum SDK is licensed under the [GNU General Public License v3.0](https://gith

## Support

Join our Discord community at [discord.gg/tCswbSK5W2](https://discord.com/invite/MBkdC3gxcv) for any questions or support.
Join our Discord community at [https://discord.com/invite/MBkdC3gxcv](https://discord.com/invite/MBkdC3gxcv) for any questions or support.
32 changes: 20 additions & 12 deletions packages/gpl-core/README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,42 @@
# @gumhq/sdk
# @magicblock-labs/gum-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">
<img alt="npm" src="https://img.shields.io/npm/v/@magicblock-labs/gum-sdk?color=%23d45bff">
<img alt="npm" src="https://img.shields.io/npm/dt/@magicblock-labs/gum-sdk?color=%23d45bff">
</p>

## Installation

Yarn:
```bash
yarn add @magicblock-labs/gum-sdk
```
or
NPM:
```bash
npm i @magicblock-labs/gum-sdk
```

## 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.
You can find the complete documentation for the Gum Session Keys SDK at https://docs.magicblock.gg/Onboarding/Session%20Keys/introduction

## Example App
## Example Game

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.
Check out the [example game](https://github.com/magicblock-labs/Kamikaze-Joe) that uses the Gum Session Keys SDK to demonstrate its capabilities. The game is a PvP arena that showcases the session keys usage.

## 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).
The Gum Session Keys 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.
Join our Discord community at [https://discord.com/invite/MBkdC3gxcv](https://discord.com/invite/MBkdC3gxcv) for any questions or support.
2 changes: 1 addition & 1 deletion packages/gpl-core/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@magicblock-labs/gum-sdk",
"version": "3.0.2",
"version": "3.0.4",
"main": "lib/index.js",
"license": "GPL-3.0",
"description": "Gum Protocol SDK",
Expand Down
2 changes: 1 addition & 1 deletion packages/react-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ yarn add @gumhq/react-sdk

## Documentation

For more detailed documentation, please visit the [Gum documentation](https://docs.gum.fun/).
For more detailed documentation, please visit the [Magicblock documentation](https://docs.gum.fun/).

## Usage

Expand Down

0 comments on commit 5046aee

Please sign in to comment.