fix: update docs to remove redundancy

- update logger in extension.md
- remove redundant stuff in README and add readthedocs link
- update FAQs

README.md

@@ -2,41 +2,13 @@
 ![Tests](https://github.com/mushorg/glutton/actions/workflows/workflow.yml/badge.svg)
 [![GoDoc](https://godoc.org/github.com/mushorg/glutton?status.svg)](https://godoc.org/github.com/mushorg/glutton)
 
-Setup `go 1.21`. 
+Glutton is a protocol-agnostic, low-interaction honeypot that intercepts network traffic and logs interactions to help analyze malicious activities. It's built using Golang and leverages iptables and TPROXY to redirect all traffic to specific protocol handlers.
 
-Install required system packages:
+## Documentation
+For more details, please read the [documentation](https://go-glutton.readthedocs.io/en/latest/), which provides the following sections:
 
-Debian:
-```
-apt-get install gcc libpcap-dev iptables
-```
-
-Arch:
-```
-pacman -S gcc libpcap iptables
-```
-
-Fedora:
-```
-sudo dnf install gcc libpcap-devel iptables
-```
-
-Build glutton:
-```
-make build
-```
-
-To run/test glutton:
-```
-sudo bin/server
-```
-
-To get this to work on WSL, use this kernel: https://github.com/Locietta/xanmod-kernel-WSL2
-
-### Setting up the Dev Container environment with VS Code
-
-Since this project requires a Linux environment to build and run, you need to use a Docker container on other operating systems. For development, we recommend using the Dev Container Extension for VS Code.
-
-First, install the Dev Container extension. To learn more about setting up and using dev containers, check out the following resources:  
-- [Install Dev Container](https://code.visualstudio.com/docs/devcontainers/containers)  
-- [Learn More](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
+* [Introduction](https://go-glutton.readthedocs.io/en/latest/)
+* [Setup](https://go-glutton.readthedocs.io/en/latest/setup/)
+* [Configuration](https://go-glutton.readthedocs.io/en/latest/configuration/)
+* [Extension](https://go-glutton.readthedocs.io/en/latest/extension/)
+* [FAQs](https://go-glutton.readthedocs.io/en/latest/faq/)

docs/extension.md

@@ -20,7 +20,6 @@ Glutton is built to be easily extensible. Developers can add new protocol handle
 
             import (
                "context"
-               "log"
                "net"
                
                "github.com/mushorg/glutton/connection"
@@ -30,7 +29,7 @@ Glutton is built to be easily extensible. Developers can add new protocol handle
             // HandleNewProtocol handles incoming connections.
             func HandleNewProtocol(ctx context.Context, conn net.Conn, md connection.Metadata, logger interfaces.Logger, h interfaces.Honeypot) error {
                // Log the connection for demonstration purposes.
-               log.Printf("Received NewProtocol connection from %s", conn.RemoteAddr().String())
+               logger.Info("Received NewProtocol connection from %s", conn.RemoteAddr().String())
                // Here you could add protocol-specific handling logic.
                // For now, simply close the connection.
                return conn.Close()

docs/faq.md

@@ -11,8 +11,11 @@
 
 ### Q: How do I configure Glutton?
 **A:** Configuration is managed through YAML files:
+
 - **config/config.yaml:** General settings such as port numbers and interface names.
 - **config/rules.yaml:** Defines rules for matching and processing network traffic.
 
+See the [Configuration](configuration.md) section for detailed instructions.
+
 ### Q: What are the system prerequisites?
-**A:** Glutton requires a Linux system, so if you're using a different OS, you'll have to use Docker to set it up. Specific installation commands are provided in the [Setup](setup.md) section.
+**A:** Glutton requires a Linux system, so if you're using a different OS, you'll have to use Docker to set it up. Specific installation commands are provided in the [Setup](setup.md) section.