diff --git a/README.md b/README.md index e3def52..67147c4 100644 --- a/README.md +++ b/README.md @@ -31,8 +31,7 @@ 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. |

npm

| -| [`@gumhq/react-sdk`](https://github.com/magicblock-labs/gum-sdk/tree/master/packages/react-sdk) | React Hooks for Gum protocol |

npm

| +| [`@magicblock-labs/gum-sdk`](https://github.com/magicblock-labs/gum-sdk/tree/master/packages/gpl-core) | Typescript client to interact with Gum protocol. |

npm

| ## Documentation @@ -40,7 +39,7 @@ npx lerna run build - [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 @@ -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. diff --git a/packages/gpl-core/README.md b/packages/gpl-core/README.md index 88b2c40..fbf24c8 100644 --- a/packages/gpl-core/README.md +++ b/packages/gpl-core/README.md @@ -1,25 +1,33 @@ -# @gumhq/sdk +# @magicblock-labs/gum-sdk

- npm - npm + npm + npm

+## 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 @@ -27,8 +35,8 @@ We welcome contributions to improve the SDK. Please raise an issue or submit a p ## 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. diff --git a/packages/gpl-core/package.json b/packages/gpl-core/package.json index 10b59a0..b1905a7 100644 --- a/packages/gpl-core/package.json +++ b/packages/gpl-core/package.json @@ -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", diff --git a/packages/react-sdk/README.md b/packages/react-sdk/README.md index 13f35f0..0a43acd 100644 --- a/packages/react-sdk/README.md +++ b/packages/react-sdk/README.md @@ -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