More documentation

README.md

-# Time Slime
+# **Time Slime**
 [![Time Slime](extras/images/Time_Slime.jpg)](http://scoobydoo.wikia.com/wiki/Time_Slime)
 
-Time Slime is a simple command line implementation of a time sheet program.
-Easily add hours to your work log, or use it as a standard time clock.
+Time Slime is a C library for implementation of a basic time sheet program.
 
-When it comes time, use it to generate reports on hours worked between two dates.
+It uses an SQLITE database to store logs, and allows you to clock in/out as well as add a set number of hours.
 
-## Getting Started
+There is also a shell interface for using only the library from the terminal.
 
+ 
 
-## Usage
+# Getting Started
 
+To use this as a library in another program, you need the `timeslime.h` and `timeslime.c` files.
+
+If your project already includes SQLITE, then replace this line, in `timeslime.h`:
+```C
+#include "third_party/sqlite3/sqlite3.h"
+```
+With:
+```C
+#include "path/to/sqlite3.h"
+```
+Pointing to your `sqlite3.h` file.
+
+If your project is NOT using SQLITE, then you need to take `third_party/sqlite3/sqlite3.h` and `third_party/sqlite3/sqlite3.c` as well,
+and change the path to `sqlite3.h` in `timeslime.h` based on where you place the files.
+
+ 
+
+# Library Documentation
+
+The Time Slime library has the following functions available for use:
+```c
+TIMESLIME_STATUS_t TimeSlime_Initialize(char directory_for_database[]);
+
+TIMESLIME_STATUS_t TimeSlime_Close(void);
+
+TIMESLIME_STATUS_t TimeSlime_AddHours(float hours, TIMESLIME_DATE_t date);
+
+TIMESLIME_STATUS_t TimeSlime_ClockIn(TIMESLIME_DATETIME_t time);
+
+TIMESLIME_STATUS_t TimeSlime_ClockOut(TIMESLIME_DATETIME_t time);
+
+TIMESLIME_STATUS_t TimeSlime_GetReport(TIMESLIME_DATE_t start, TIMESLIME_DATE_t end, TIMESLIME_REPORT_t **out);
+
+void TimeSlime_FreeReport(TIMESLIME_REPORT_t **report);
+
+char*  TimeSlime_StatusCode(TIMESLIME_STATUS_t status);
+```
+
+### Time Slime Status
+`TIMESLIME_STATUS_t` is a type alias for `int`, and can be one of the following (defined in `timeslime.h`):
+|Value|Description|
+|-----|------------|
+|`TIMESLIME_OK`|No problems or errors|
+|`TIMESLIME_UNKOWN_ERROR`|Unkown error prevented function from finishing|
+|`TIMESLIME_SQLITE_ERROR`|Problem executing SQLITE actions|
+|`TIMESLIME_INVALID_YEAR`|Invalid year in parameter object|
+|`TIMESLIME_INVALID_MONTH`|Invalid month in parameter object|
+|`TIMESLIME_INVALID_DAY`|Invalid day in parameter object|
+|`TIMESLIME_INVALID_HOUR`|Invalid hour in parameter object|
+|`TIMESLIME_INVALID_MINUTE`|Invalid minute in parameter object|
+|`TIMESLIME_ALREADY_CLOCKED_IN`|Unable to clock in since a clock out action has not been performed|
+|`TIMESLIME_NOT_CLOCKED_IN`|Unable to clock out since a clock in action has not been performed|
+|`TIMESLIME_NO_ENTIRES`|No time sheet entries were found for a given date range|
+
+If you want to get a string key that represents a status code,
+use the `TimeSlime_StatusCode(TIMESLIME_STATUS_t)` method, and pass in the status code. A string will be returned.
+
+## Inititialization
+The `TimeSlime_Initialize(char[])` function needs to be called before any other Time Slime methods. This is responsible for creating the SQLITE database if it does not exist.
+
+The parameter passed to this should be the directory to place the the `timeslime.db` file (**WITHOUT** a trailing slash).
+
+## Closing
+The `TimeSlime_Close()` function needs to be called before exiting your program, it is responsible for safely disposing of allocated memory.
+
+
+## Adding Hours
+It might be desired to add a set number of hours to a time sheet for a specific date (rather than clocking in and out).
+
+This is where the `TimeSlime_AddHours(float, TIMESLIME_DATE_t)` functions comes in.
+
+The function accepts a `float`, which is the number of hours worked. Then a `TIMESLIME_DATE_t` struct, which is the date to add the hours to.
+
+[See more about `TIMESLIME_DATE_t`](#Library-Datatypes).
+
+## Clocking In and Out
+To clock in and out of the time sheet, use the `TimeSlime_ClockIn(TIMESLIME_DATETIME_t)` and `TimeSlime_ClockOut(TIMESLIME_DATETIME_t)` functions.
+
+Each function accepts a `TIMESLIME_DATETIME_t` struct, which represents the date and time that the clock in, clock out should be performed on.
+
+[See more about `TIMESLIME_DATETIME_t`](#Library-Datatypes).
+
+
+## Reports
+Generating a report will show you how many hours have been worked per day for a certain date range.
+
+`TimeSlime_GetReport(TIMESLIME_DATE_t start, TIMESLIME_DATE_t end, TIMESLIME_REPORT_t **out)`
+will generate a report between the `start` and `end` dates.
+
+The result will be placed in the `TIMESLIME_REPORT_t` pointer, and this needs to be passed a pointer to that pointer.
+
+[See more about `TIMESLIME_DATE_t` and `TIMESLIME_REPORT_t`](#Library-Datatypes).
+
+ 
+
+# Library Datatypes
+
+## Date and DateTime
+To avoid conflict with other libraries, Time Slime defines a custom struct for passing in
+dates and datetimes.
+
+```c
+struct TIMESLIME_DATE_STRUCT
+{
+    int year;
+    int month;
+    int day;
+};
+typedef struct TIMESLIME_DATE_STRUCT TIMESLIME_DATE_t;
+
+struct TIMESLIME_DATETIME_STRUCT
+{
+    int year;
+    int month;
+    int day;
+    int hour;
+    int minute;
+};
+typedef struct TIMESLIME_DATETIME_STRUCT TIMESLIME_DATETIME_t;
+```
+
+Time Slime also defines some helpful directives to easily create these for the current time.
+
+```c
+#define TIMESLIME_DATE_NOW         (TIMESLIME_DATE_t){ 0, 0, 0}
+#define TIMESLIME_TIME_NOW         (TIMESLIME_DATETIME_t){ 0, 0, 0, 0, 0 }
+```
+
+## Report
+The `TIMESLIME_STATUS_REPORT_t` struct looks like:
+```c
+// Report Entry
+struct TIMESLIME_REPORT_ENTRY_STRUCT
+{
+    float Hours;
+    char Date[];
+};
+typedef struct TIMESLIME_REPORT_ENTRY_STRUCT TIMESLIME_REPORT_ENTRY_t;
+
+// Time Sheet Report
+struct TIMESLIME_REPORT_STRUCT
+{
+    int NumberOfEntries;
+    TIMESLIME_REPORT_ENTRY_t Entries[];
+};
+typedef struct TIMESLIME_REPORT_STRUCT TIMESLIME_REPORT_t;
+```
+
+
+ 
+
+# Terminal Usage

timeslime.c

@@ -4,7 +4,6 @@
  * Authors: Michael Rouse
  */
 #include "timeslime.h"
-#include "third_party/sqlite3/sqlite3.h"
 
 /* Row result for internal library use */
 struct TIMESLIME_INT_ROW_STRUCT {
@@ -321,10 +320,6 @@ char*  TimeSlime_StatusCode(TIMESLIME_STATUS_t status)
             return "INVALID_HOUR";
         case TIMESLIME_INVALID_MINUTE:
             return "INVALID_MINUTE";
-        case TIMESLIME_INVALID_TIMESTAMP:
-            return "INVALID_TIMESTAMP";
-        case TIMESLIME_INVALID_DATE:
-            return "INVALID_DATE";
         case TIMESLIME_ALREADY_CLOCKED_IN:
             return "ALREADY_CLOCKED_IN";
         case TIMESLIME_NOT_CLOCKED_IN:

timeslime.h

@@ -6,6 +6,8 @@
 #ifndef __TIME_SLIME_H__
 #define __TIME_SLIME_H__
 
+#include "third_party/sqlite3/sqlite3.h"
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
@@ -13,7 +15,7 @@
 /* Constants */
 /* These are used when you want to use the current date */
 #define TIMESLIME_DATE_NOW         (TIMESLIME_DATE_t){ 0, 0, 0}
-#define TIMESLIME_TIME_NOW         (TIMESLIME_DATETIME_t) { 0, 0, 0, 0, 0 }
+#define TIMESLIME_TIME_NOW         (TIMESLIME_DATETIME_t){ 0, 0, 0, 0, 0 }
 
 #ifndef TIMESLIME_DATABASE_FILE_NAME
 #define TIMESLIME_DATABASE_FILE_NAME    "timeslime.db"
@@ -36,8 +38,7 @@
 #define TIMESLIME_INVALID_DAY       12
 #define TIMESLIME_INVALID_HOUR      13
 #define TIMESLIME_INVALID_MINUTE    14
-#define TIMESLIME_INVALID_TIMESTAMP 15
-#define TIMESLIME_INVALID_DATE      16
+
 
 #define TIMESLIME_ALREADY_CLOCKED_IN    60  /* When you try to clock in without clocking out */
 #define TIMESLIME_NOT_CLOCKED_IN        61 /* When you try to clock out without clocking in */