Merge branch 'master' of https://github.com/DavidF-Dev/Unity-MathsHelper

Author: DavidF-Dev

.github/README.md

@@ -1,4 +1,5 @@
 # Maths & Random Helper Functions for Unity
+This asset contains a series of maths & random helper functions to assist in calculations in your games.
 
 ## Setup
 Simply import the package into your project and you're good to go. No additional setup is required.
@@ -8,6 +9,23 @@ Simply import the package into your project and you're good to go. No additional
   - <i>Or</i> add the following line to <i>Packages/manifest.json</i>:</br>``"com.davidfdev.maths": "https://github.com/DavidF-Dev/Unity-MathsHelper.git"``
 
 ## Usage
+To access the scripts, include the ``DavidFDev.Maths`` namespace to access the ``MathsHelper`` and ``RandomHelper`` static classes.</br>
+Or, alternatively, use ``using static DavidFDev.Maths.MathsHelper`` and ``using static DavidFDev.Maths.RandomHelper`` to use the methods without needing to specify the classname (e.g. ``NextBool()`` instead of ``RandomHelper.NextBool()``).
+
+The ``MathsHelper`` class contains many helpful maths methods, such as:
+- ``Approach / ApproachAngle : float``
+- ``Reduce / ReduceAngle : float``
+- ``Sign / SignThreshold : float``
+- ``Map10 / Map01 / Map : float``
+- ``GetAngle / GetAngleBetween : float``
+- ``RotateVector : Vector2``
+
+</br>The ``RandomHelper`` class contains various methods for retrieving random values, such as:
+- ``Next : bool/float/int/Angle/Colour/Vector2/Vector3``
+- ``Range : float/Vector2/Vector3``
+- ``MinusOneToOne / MinusOneOrOne() : float``
+- ``Chance : bool``
+- ``Choose : Element``
 
 ## Contact
 If you have any questions or would like to get in contact, shoot me an email at [email protected]. Alternatively, you can send me a direct message on Twitter at [@DavidF_Dev](https://twitter.com/DavidF_Dev).</br></br>