From b47abf03df8ed850d5263f80ac421a6196c2d620 Mon Sep 17 00:00:00 2001
From: tobonev <92880370+tobonev@users.noreply.github.com>
Date: Sun, 29 Sep 2024 21:11:49 -0400
Subject: [PATCH] Updated README.md to include additional information

Updated README.md to include information on APIs and open source software used to create this project. Included longer description of project features as well as compatibility with mobile and desktop browsers.
---
 README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 57 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1c75a49..05d1437 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,70 @@
 
 # Contract Killer Generator #
 
-This simple tools allow anyone to create a contract based on **[Contract Killer v3](https://gist.github.com/4031110)** the popular open-source contract for web designers and developers. It offers a sleek user interface to edit the contract terms, and you can also export to PDF.
+This simple tools allow anyone to create a contract based on **[Contract Killer v3](https://gist.github.com/4031110)** the popular open-source contract for web designers and developers. It offers a sleek user
+interface to edit the contract terms, and you can also export to PDF. Our tool is developed off of a common but efficient contract template which has been used by thousands of wen designers and developers to
+create concise contracts. 
+
+# How to Use #
+The use of our contract generator software is quite simple. Simply go to [https://siamkreative-ckg.surge.sh/](https://siamkreative-ckg.surge.sh/), and begin entering all of the information on the left hand side
+of the page. A preview of certain aspects of the contract will automatically be updated as they are input into the system. Once you are finished editing, simply click "Save as PDF" to save the contract locally 
+to your computer. 
+
+# Features #
+
+- Company name and Logo
+- Company Address
+- Customer Name
+- Customer Address
+- Description of Task Being Completed
+- Total price of task
+- Date which the task will be completed
+- Payment schedule
+- Courts responsible for enforcement (with built in search feature for local courts)
+
+# Compatability #
+
+The contracts are tested on all major desktop browsers including Safari, Google Chrome, Mozilla Firefox, Microsfot Edge, and more. The contracts are also tested on mobile browsers such as Safari, Chrome, and
+Firefox to ensure compatibility. This cross compatability is made easy by the use of Twitter Bootstrap and jQuery.
 
 ## Demo
 
 You can try it yourself on [https://siamkreative-ckg.surge.sh/](https://siamkreative-ckg.surge.sh/)
 
+# jsPDF API #
+
+jsPDF is a free software used to convert the HTML to PDF for the contract. Some of the features implemented from jsPDF include:
+  - Adding an image
+  - Changing font
+  - Saving files
+
+# Telize #
+
+Telize is free software which allows a user's location to be determined through the users IP address. This software is used in order to locate local courts which can be listed on the contract as an enforcement measure. 
+
+# Twitter Bootstrap #
+
+Twitter Bootstrap is used for the user inteface components of the webpage. Twitter Bootstrap has many benefits, such as:
+  - Cross-compatability
+  - Responsive
+  - Customizable
+  - Open-source
+
+# jQuery #
+
+jQuery is used to simplify event handling. jQuery has a variety of features, such as:
+  - Simplified event binding
+  - Event delegation
+  - Concise code
+
+
 ### Technical details
 
 - Twitter Bootstrap & jQuery
 - [jsPDF](https://parall.ax/products/jspdf) for HTML to PDF conversion
 - [Telize](http://www.telize.com/) for Geolocation
+
+# Contributions #
+
+There are many ways to contribute to this project, whether it be opening an issue for support or contributing code. If you wish to contrbute code or documentation for the project, you should fork the repository
+and open a pull request. If you wish to report an issue, please open up an issue on Github.