forked from gumhq/sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d1c0d57
commit 5046aee
Showing
4 changed files
with
25 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters