From ac2374ca9215fe52be062ab12fe37caf645ba39a Mon Sep 17 00:00:00 2001
From: asandikci <git@aliberksandikci.com.tr>
Date: Thu, 24 Aug 2023 19:10:48 +0300
Subject: [PATCH] update readme

---
 Dockerfile |  2 +-
 README.md  | 56 ++++++++++++++++++++++++++++++++++++++++++++++--------
 2 files changed, 49 insertions(+), 9 deletions(-)

diff --git a/Dockerfile b/Dockerfile
index 946ed76..7d19ff6 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -9,7 +9,7 @@ RUN apt-get update
 RUN apt-get upgrade -y
 
 ### INSTALL USEFUL UTILITIES ###
-RUN apt-get install curl wget tree nano procps lintian -y 
+RUN apt-get install git curl wget tree nano procps lintian -y 
 
 ### INSTALL BUILD DEPENDENCIES ###
 RUN apt-get install sudo dpkg-dev debhelper golang-any -y
diff --git a/README.md b/README.md
index fae5ea1..6ee79c2 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,55 @@
 # Ahenk Go
 
-Ahenk Agent for Liderahenk Central Management System - Go Implementation
+**Liderahenk** is an open source project which provides solutions to manage, monitor and audit unlimited number of different systems and users on a network.
 
-Tamamdır hallettim sorunu. dpkg-buildpackage, makefile'ı çağırıyormuş. Anlayana kadar canım çıktı 😅
----
+Ahenk-go is a Linux agent written in Go which enables Lider to manage & monitor clients remotely.
+
+### Creating Docker Development Environment (Optional)
+1. Install and Create docker environment, [Quick Start](https://sulincix.github.io/sayfalar/html/docker-kullanimi.html)
+2. Pull docker image
+```sh
+docker pull asandikci/godeb
+```
+> Or alternatively build Dockerfile with `docker build -t godeb:latest` code for lower data usage
+
+3. Create container from image and attach to container, an example:
+```sh
+docker run -it -d --name build1 asandikci/godeb:latest "bin/bash"
+docker attach build1 --detach-keys "ctrl-k"
+```
+## Packaging
+1. Install necessary packages (You dont need this step if you are using docker file)
+```sh
+sudo apt install sudo dpkg-dev debhelper golang-any 
+``` 
+2. Clone the repository and move to main directory
+```sh
+git clone https://git.aliberksandikci.com.tr/Liderahenk/ahenk-go/
+cd ahenk-go/
+```
+3. Build program and create binary/source packages
+```sh
+dpkg-buildpackage
+```
+> Refer to Makefile for more info
+
+### Documentation
+- See [Liderahenk/ahenk-docs](https://git.aliberksandikci.com.tr/Liderahenk/ahenk-docs/) for comprehensively prepared documentation.
 
 
-### Useful Links
-| Explanation | Link |
-| ----------- | ---- |
-| Ahenk-go documentation | [Liderahenk/ahenk-docs](https://git.aliberksandikci.com.tr/Liderahenk/ahenk-docs/) |
-| Current Python Implementation of Ahenk | [Pardus-LiderAhenk/ahenk](https://github.com/Pardus-LiderAhenk/ahenk/) |
+## Other Liderahenk Projects
+- [Pardus-LiderAhenk/ahenk](https://github.com/Pardus-LiderAhenk/ahenk/): Current Python Implementation of Ahenk 
+- [Lider UI](https://github.com/Pardus-LiderAhenk/liderui): Lider Administration User Interface
+- [Lider API](https://github.com/Pardus-LiderAhenk/liderapi): Lider API
+- [Liderahenk-ansible](https://github.com/Pardus-LiderAhenk/liderahenk-ansible): Liderahenk setup with ansible  
+- [Ahenkdesk](https://github.com/Pardus-LiderAhenk/ahenkdesk): Ahenk User Interface
+- See more in our [GitHub Page](https://github.com/Pardus-LiderAhenk)
 
 
+## Changelog
+See [changelog](./debian/changelog) to learn what have been changed between releases or refer to [Releases](./releases) Tab above
+
+
+## License
+Lider Ahenk and its sub projects are licensed under the [LGPL v3](./LICENSE).
+