doc: Adding end user documentation

README.md

@@ -1 +1,59 @@
-# psutil-golang-RawanMostafa
+# Psutils
+
+This repository implements a human-friendly lib for querying processes, memory info and cpu info
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+
+
+## Installation
+
+Get the package
+
+   ```bash
+     go get github.com/codescalersinternships/psutil-golang-RawanMostafa
+   ```
+Import the package
+
+  ```go
+     import github.com/codescalersinternships/psutil-golang-RawanMostafa/pkg
+  ```
+
+## Usage
+
+  The psutils package offers different APIs like:
+
+### 1. CPU related APIs
+
+```go
+  cpuInfo, err := psutils.GetCpuInfo()
+    if err != nil {
+        //handle the error
+    }
+```
+
+### 2. Memory related APIs
+
+```go
+   memInfo, err := psutils.GetMemInfo()
+    if err != nil {
+        //handle the error
+    }
+```
+### 3. Processes related APIs
+
+1. ```go
+	procs, err := psutils.GetProcessList()
+    if err != nil {
+        //handle the error
+    }
+   ```
+
+2. ```go
+	procDetails, err := psutils.GetProcessDetails(1)
+    if err != nil {
+        //handle the error
+    }
+   ```

cmd/main.go

@@ -8,12 +8,15 @@ import (
 
 func main() {
 	cpuInfo, _ := psutils.GetCpuInfo()
-	log.Printf("%v",cpuInfo)
+	log.Printf("%v", cpuInfo)
 	memInfo, err := psutils.GetMemInfo()
-	log.Printf("%v",memInfo)
-	log.Printf("err %v",err)
+	log.Printf("%v", memInfo)
+	log.Printf("err %v", err)
 	procs, err := psutils.GetProcessList()
-	log.Printf("%v\n",procs)
-	log.Printf("err %v",err)
+	log.Printf("%v\n", procs)
+	log.Printf("err %v", err)
+	det, err := psutils.GetProcessDetails(1)
+	log.Printf("%v\n", det)
+	log.Printf("err %v", err)
 
 }