Tayx94 / graphy

Graphy is the ultimate, easy to use, feature packed FPS counter, stats monitor and debugger for your Unity project.
MIT License
2.48k stars 213 forks source link

Enhance README for Clarity and Usability #119

Closed Tyler-JP closed 5 months ago

Tyler-JP commented 7 months ago

This pull request introduces several enhancements to the Graphy README documentation, aimed at improving clarity, usability, and providing comprehensive guidance for new users and contributors. The key changes include:

  1. Table of Contents: Added a Table of Contents to make navigating the README more efficient.

  2. Installation Guide Overhaul: The installation instructions have been changed to create a more clear understanding of the various methods of installing. Divided into the sections: Unity Asset Store, OpenUPM, and the Unity Package Manager. The goal is to make the setup process as seamless and straightforward as possible.

  3. Quick Start Guide: A new Quick Start section has been added to help users get Graphy up and running in their Unity projects quickly. And have some idea of the various configurables.

  4. Practical Use Cases: To demonstrate the versatility and power of Graphy, I included a section outlining various practical use cases. This section aims to inspire users by showing how Graphy can be utilized.

These changes are intended to make the README a more valuable resource for both new and existing users.