jordon/HarmonyLink
1
0
Fork 0
Code Issues Pull requests Projects Releases 5 Packages Wiki Activity Actions

Updated Home (markdown)

Jordon Brooks 2023-06-26 20:58:05 +01:00
parent f059382432
commit f1b5074a1b
1 changed files with 13 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

14
Home.md

@ -2,4 +2,16 @@
This wiki provides detailed documentation for HarmonyLinkServer, an API server for enhancing the handheld gaming experience. This wiki provides detailed documentation for HarmonyLinkServer, an API server for enhancing the handheld gaming experience.
- [Endpoints](Endpoints) ## Introduction
HarmonyLinkServer is a powerful API server developed with the Rust programming language. It aims to enhance the gaming experience on handheld devices by providing real-time metrics and cross-platform compatibility. This server-side application is a crucial component of the HarmonyLink project, enabling games to access device-specific information and adapt their settings accordingly.
## Documentation
To get started with HarmonyLinkServer, you can refer to the following documentation:
- [Endpoints](Endpoints): This page provides a detailed overview of the API endpoints available in HarmonyLinkServer, including their URLs, methods, and response formats. It is a comprehensive resource for understanding how to interact with the server and retrieve device metrics.
- [Getting Started](Getting-Started): This page provides step-by-step instructions on how to set up and run HarmonyLinkServer on different platforms. It covers prerequisites, compilation, and execution of the server application.
- [HarmonyLink: View](https://github.com/Jordonbc/HarmonyLinkView): This sister project offers a user-friendly interface to visualize the data provided by the HarmonyLinkServer API. It allows you to explore and analyze real-time device metrics, providing insights into the performance of your handheld gaming experience.