![\"Logo\"](\"https://raw.githubusercontent.com/barbarbar338/react-use-lanyard/main/assets/readme.png\")
\r\n \r\n \r\n
\r\n Use Lanyard API easily in your React app!\r\n
\r\n Get support »\r\n
\r\n
\r\n Report Bug\r\n ·\r\n Request Feature\r\n ·\r\n What Is Lanyard\r\n
{!lanyard.isValidating && JSON.stringify(lanyard, null, 4)}\r\n\t);\r\n}\r\n\r\nexport default App;\r\n```\r\n\r\nUsing with websocket:\r\n\r\n```js\r\nimport { useLanyard } from \"react-use-lanyard\";\r\n\r\nfunction App() {\r\n\tconst { loading, status /*, websocket */ } = useLanyard({\r\n\t\tuserId: \"952574663916154960\",\r\n\t\tsocket: true,\r\n\t});\r\n\r\n\treturn {!loading && JSON.stringify(status, null, 4)};\r\n}\r\n\r\nexport default App;\r\n```\r\n\r\n# 🔐 KV Support\r\n\r\nYou can create/delete KV pairs using this package.\r\n\r\n```js\r\nimport { set, del } from \"react-use-lanyard\";\r\n\r\n// Set KV pair\r\nawait set({\r\n\tapiKey: \"your_api_key\", // get it using .apikey command on lanyard bot\r\n\tuserId: \"your_user_id\",\r\n\tkey: \"test_key\",\r\n\tvalue: \"test value\",\r\n\t// apiUrl: \"lanyard.338.rocks\", // if you are using self-hosted api, not required by default\r\n});\r\n\r\n// Delete KV pair\r\nawait del({\r\n\tapiKey: \"your_api_key\",\r\n\tuserId: \"your_user_id\",\r\n\tkey: \"test_key\",\r\n\t// apiUrl: \"lanyard.338.rocks\", // if you are using self-hosted api, not required by default\r\n});\r\n```\r\n\r\n# 🤞 Using Self-Hosted API\r\n\r\nYou can use this package to connect to your own self-hosted Lanyard API. To do this, you need to pass the `apiUrl` option to the `useLanyard` hook. See [Lanyard self-hosting guide](https://github.com/Phineas/lanyard#self-host-with-docker) for more information.\r\n\r\nUsing without websocket:\r\n\r\n```js\r\nimport { useLanyard } from \"react-use-lanyard\";\r\n\r\nfunction App() {\r\n\tconst lanyard = useLanyard({\r\n\t\tuserId: \"952574663916154960\",\r\n\t\tapiUrl: \"lanyard.338.rocks\",\r\n\t});\r\n\r\n\treturn (\r\n\t\t{!lanyard.isValidating && JSON.stringify(lanyard, null, 4)}\r\n\t);\r\n}\r\n\r\nexport default App;\r\n```\r\n\r\nUsing with websocket:\r\n\r\n```js\r\nimport { useLanyard } from \"react-use-lanyard\";\r\n\r\nfunction App() {\r\n\tconst { loading, status /*, websocket */ } = useLanyard({\r\n\t\tuserId: \"952574663916154960\",\r\n\t\tsocket: true,\r\n\t\tapiUrl: \"lanyard.338.rocks\",\r\n\t});\r\n\r\n\treturn {!loading && JSON.stringify(status, null, 4)};\r\n}\r\n\r\nexport default App;\r\n```\r\n\r\n# 📄 License\r\n\r\nCopyright © 2021 [Barış DEMİRCİ](https://github.com/barbarbar338).\r\n\r\nDistributed under the [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.html) License. See `LICENSE` for more information.\r\n\r\n# 🧦 Contributing\r\n\r\nFeel free to use GitHub's features.\r\n\r\n1. Fork the Project\r\n2. Create your Feature Branch (`git checkout -b feature/my-feature`)\r\n3. Run prettier and eslint (`npm run format && npm run lint`)\r\n4. Commit your Changes (`git commit -m 'my awesome feature my-feature'`)\r\n5. Push to the Branch (`git push origin feature/my-feature`)\r\n6. Open a Pull Request\r\n\r\n# 🔥 Show your support\r\n\r\nGive a ⭐️ if this project helped you!\r\n\r\n# 📞 Contact\r\n\r\n- Mail: hi@338.rocks\r\n- Discord: https://discord.gg/BjEJFwh\r\n\r\n# ✨ Special Thanks\r\n\r\n- [Phineas](https://github.com/Phineas) - Creator of [Lanyard API](https://github.com/Phineas/lanyard)\r\n- [Eggsy](https://github.com/eggsy) - Creator of [vue-lanyard](https://www.npmjs.com/package/@eggsydev/vue-lanyard)\r\n","readmeFilename":"README.md"}