diff --git a/README.md b/README.md index 653492e..e227799 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,39 @@ # Timer_Class -Simple and small timer class to allow tracking of functions/API's and ajax calls. \ No newline at end of file +Simple and small timer class to allow tracking of functions/API's and ajax calls. + +1. udate - Converts a micro timestamp into a date format +2. start - Stores the start time +3. end - Stores the end time +4. time - Returns the (end - start) times **NO FORMATING** +5. format_time - Returns the (end - start) times formated +6. avg_time - Returns the (end - start) times **NO FORMATING** +7. format_avg_time - Returns the (end - start) times formated + +Quick Example +----- +**timer-example.php** + +``` +start(); // <- Places a value for Start of Timer + sleep(5); // <- Pause + $timer->end(); // <- Places a value for End of Timer +// -- Output the Results + echo $timer->startTimer . '
'; + echo $timer->endTimer . '
'; + echo $timer->time() . '
'; + echo $timer->format_time() . '
'; + echo $timer->avg_time(5) . '
'; + echo $timer->format_avg_time(5); +// =================================================== + +$timer = null; + +``` \ No newline at end of file