From adf47a8e324497369c916a5f6c00b99bd76ffc9b Mon Sep 17 00:00:00 2001 From: root Date: Mon, 18 Mar 2019 20:24:13 -0400 Subject: [PATCH] updated README with install details and more about the project --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 0be6d3c7..2b8cd366 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,9 @@ ## CRM +This is a Customer Relationship Management system for small Managed IT Companies. This was developed so we didn't have to worry about managing +three different systems. Before we used to use a wiki for internal and client documentation. Accounting software and invoicing software. This is an all in +one solution. +This is still in early development stages and by no means ready for the primetime. Please report bugs, and send some pulls, if you find this useful. + ### Features * Manage Clients * Contacts @@ -15,6 +20,19 @@ * Income Expense Summary * Mileage Tracking +### Installation Instructions + +* create a mysql database dump db.sql into it +* set db user and password in config.php +* Point your browser and away you go + +#### Requirements +* Linux +* Webserver (Apache, NGINX) +* PHP7+ +* Mysql or MariaDB + + ### Technologies Used * PHP/MySQL