linux_stat 2.0.1 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1292d974695e1622fd5ca04cd91393b325a8acd4116727498b077b74b530aa6
-  data.tar.gz: ba39825500d32ebaafa6d0a6176901c34e9abc98ea747f6035f4731db9ed1818
+  metadata.gz: 7a2257dd9d025a05cf31fbfdf06d67933abd1d355678fe23c0ab1d5797fce9e9
+  data.tar.gz: 3898fa563cda7716321f689a64448afb0b46bb7ba1c9bac297c9f3ba0e9e4f38
 SHA512:
-  metadata.gz: 4ae4eed738ade10f5aa8202a6552c9a4e05d2e8ba22c6f2e6f2b8f5f59a38f057befe3f2b5cef4302917ba04477c21a5fedf34538cca32256dea55df408dcee5
-  data.tar.gz: 1569d7d670cb488b10fac97f0bfcf9c8e6c9ce3ff997524dc478e5a762e7806bbf84fb06e31f4c7376ef0c2f48e6b08f5f27671abdc5c7d54e041971ca17da64
+  metadata.gz: 5b6fede8da5d7a14322253c8c108b56069f0d3089349f23a9b7c207500c240b8a855a847dc9de649797da81466e449911609f3308473a4d8f5c32c1d0622cf46
+  data.tar.gz: 0f61a61920ca364cba0b3e664ff67bab7fcbf45d3d47eaea622b71b2fde7585cb761025f1b02d8f7e80ea0105b66541432cdb7ca12594938a6d5f04c0d648b05

data/README.md

@@ -8,11 +8,27 @@ For reading the eyecandy HTML version, visit [linux_stat](https://souravgoswami.
 
 LinuxStat lets you read status of a Linux system. It can show you cpu stats and usages, memory stats and usages, swap stats and usages, battery usage, bios info,  kernel details, local ip, os details and parse os-release + lsb-release, etc.
 
-It only works for Linux, and detecting the OS is upto the user of this gem.
+It only works on Linux, and detecting the OS is upto the user of this gem.
 
-Languages Used:
+---
 
-<img src="https://linuxstatloc.herokuapp.com/svg" width="260px">
+| Table of Contents |
+|:---|
+| [Runtime Dependencies](https://github.com/Souravgoswami/linux_stat#runtime-dependencies) |
+| [Build Dependencies](https://github.com/Souravgoswami/linux_stat#build-dependencies) |
+| [Optional Runtime Dependencies](https://github.com/Souravgoswami/linux_stat#optional-runtime-dependencies) |
+| [Installation](https://github.com/Souravgoswami/linux_stat#installation) |
+| [Usage](https://github.com/Souravgoswami/linux_stat#usage) |
+| [Notes](https://github.com/Souravgoswami/linux_stat#notes) |
+| [Return Types](https://github.com/Souravgoswami/linux_stat#return-types) |
+| [Ruby On Rails](https://github.com/Souravgoswami/linux_stat#ruby-on-rails) |
+| [Android](https://github.com/Souravgoswami/linux_stat#android) |
+| [Cloning this Repo](https://github.com/Souravgoswami/linux_stat#cloning-this-repo) |
+| [Development](https://github.com/Souravgoswami/linux_stat#development) |
+| [Testing](https://github.com/Souravgoswami/linux_stat#testing) |
+| [Contributing](https://github.com/Souravgoswami/linux_stat#contributing) |
+| [License](https://github.com/Souravgoswami/linux_stat#license) |
+| [Languages](https://github.com/Souravgoswami/linux_stat#languages) |
 
 ---
 
@@ -84,1050 +100,42 @@ $ gem install linux_stat
 ```
 
 ## Usage
-Following are the LinuxStat modules and module functions.
-It's generated by linuxstat.rb command, which is available after the installation.
-
-For ease of use, LinuxStat is also assigned to the LS constant.
-
-#### LinuxStat::BIOS
-```
-# File:		bios.rb | Line: 58
-# Definition:	def date
-LinuxStat::BIOS.date()
-=> "04/10/2017"
-
-# File:		bios.rb | Line: 12
-# Definition:	def model
-LinuxStat::BIOS.model()
-=> "Inspiron 5567"
-
-# File:		bios.rb | Line: 29
-# Definition:	def vendor
-LinuxStat::BIOS.vendor()
-=> "Dell Inc."
-
-# File:		bios.rb | Line: 44
-# Definition:	def version
-LinuxStat::BIOS.version()
-=> "1.1.2"
-
-```
-
-### LinuxStat::Battery
-```
-# File:		battery.rb | Line: 107
-# Definition:	def charge
-LinuxStat::Battery.charge()
-=> 100.0
-
-# File:		battery.rb | Line: 124
-# Definition:	def charge_full_design_wh
-LinuxStat::Battery.charge_full_design_wh()
-=> 42.0
-
-# File:		battery.rb | Line: 143
-# Definition:	def charge_full_wh
-LinuxStat::Battery.charge_full_wh()
-=> 23.79
-
-# File:		battery.rb | Line: 80
-# Definition:	def charging?
-LinuxStat::Battery.charging?()
-=> true
-
-# File:		battery.rb | Line: 186
-# Definition:	def devices_stat
-LinuxStat::Battery.devices_stat()
-=> {:AC=>{:type=>"Mains", :online=>1}, :BAT0=>{:model=>"DELL CYMGM77", :manufacturer=>"Samsung SDI", :type=>"Battery", :status=>"Full", :capacity=>100, :voltage_min_design=>11.4, :charge_full_design=>3.684, :charge_full_design_wh=>42.0, :voltage_now=>12....
-
-# File:		battery.rb | Line: 89
-# Definition:	def discharging?
-LinuxStat::Battery.discharging?()
-=> false
-
-# File:		battery.rb | Line: 98
-# Definition:	def full?
-LinuxStat::Battery.full?()
-=> true
-
-# File:		battery.rb | Line: 49
-# Definition:	def manufacturer
-LinuxStat::Battery.manufacturer()
-=> "Samsung SDI"
-
-# File:		battery.rb | Line: 38
-# Definition:	def model
-LinuxStat::Battery.model()
-=> "DELL CYMGM77"
-
-# File:		battery.rb | Line: 10
-# Definition:	def present?
-LinuxStat::Battery.present?()
-=> true
-
-# File:		battery.rb | Line: 18
-# Definition:	def stat
-LinuxStat::Battery.stat()
-=> {:model=>"DELL CYMGM77", :manufacturer=>"Samsung SDI", :technology=>"Li-ion", :status=>"Full", :charge=>100.0, :charging=>true, :discharging=>false, :full=>true}
-
-# File:		battery.rb | Line: 70
-# Definition:	def status
-LinuxStat::Battery.status()
-=> "Full"
-
-# File:		battery.rb | Line: 59
-# Definition:	def technology
-LinuxStat::Battery.technology()
-=> "Li-ion"
-
-# File:		battery.rb | Line: 162
-# Definition:	def voltage_now
-LinuxStat::Battery.voltage_now()
-=> 12.538
-
-```
-
-### LinuxStat::CPU
-```
-# File:		cpu.rb | Line: 289
-# Definition:	def available_governors
-LinuxStat::CPU.available_governors()
-=> {"cpu0"=>["performance", "powersave"], "cpu1"=>["performance", "powersave"], "cpu2"=>["performance", "powersave"], "cpu3"=>["performance", "powersave"]}
-
-# File:		cpu.rb | Line: 88
-# Definition:	def count
-LinuxStat::CPU.count()
-=> 4
-
-# File:		cpu.rb | Line: 105
-# Definition:	def count_online
-LinuxStat::CPU.count_online()
-=> 4
-
-# File:		cpu.rb | Line: 199
-# Definition:	def cur_freq
-LinuxStat::CPU.cur_freq()
-=> {"cpu0"=>1980781, "cpu1"=>2000008, "cpu2"=>1760131, "cpu3"=>2000064}
-
-# File:		cpu.rb | Line: 267
-# Definition:	def governor
-LinuxStat::CPU.governor()
-=> {"cpu0"=>"performance", "cpu1"=>"performance", "cpu2"=>"performance", "cpu3"=>"performance"}
-
-# File:		cpu.rb | Line: 243
-# Definition:	def max_freq
-LinuxStat::CPU.max_freq()
-=> {"cpu0"=>2000000, "cpu1"=>2000000, "cpu2"=>2000000, "cpu3"=>2000000}
-
-# File:		cpu.rb | Line: 221
-# Definition:	def min_freq
-LinuxStat::CPU.min_freq()
-=> {"cpu0"=>2000000, "cpu1"=>2000000, "cpu2"=>2000000, "cpu3"=>2000000}
-
-# File:		cpu.rb | Line: 186
-# Definition:	def model
-LinuxStat::CPU.model()
-=> "Intel(R) Core(TM) i3-6006U CPU @ 2.00GHz"
-
-# File:		cpu.rb | Line: 165
-# Definition:	def offline
-LinuxStat::CPU.offline()
-=> []
-
-# File:		cpu.rb | Line: 134
-# Definition:	def online
-LinuxStat::CPU.online()
-=> [0, 1, 2, 3]
-
-# File:		cpu.rb | Line: 25
-# Definition:	def stat(sleep = ticks_to_ms_t5)
-LinuxStat::CPU.stat(sleep)
-=> {0=>9.52, 1=>16.67, 2=>16.67, 3=>0.0, 4=>0.0}
-
-# File:		cpu.rb | Line: 65
-# Definition:	def total_usage(sleep = ticks_to_ms_t5)
-LinuxStat::CPU.total_usage(sleep)
-=> 0.0
-
-# File:		cpu.rb | Line: 65
-# Definition:	def total_usage(sleep = ticks_to_ms_t5)
-LinuxStat::CPU.usage(sleep)
-=> 5.0
-
-# File:		cpu.rb | Line: 25
-# Definition:	def stat(sleep = ticks_to_ms_t5)
-LinuxStat::CPU.usages(sleep)
-=> {0=>5.26, 1=>20.0, 2=>0.0, 3=>0.0, 4=>0.0}
-
-```
-
-### LinuxStat::FS
-```
-LinuxStat::FS.stat(arg = "/")
-=> {:block_size=>4096, :fragment_size=>4096, :blocks=>29292283, :block_free=>8714668, :block_avail_unpriv=>8714668, :inodes=>58612160, :free_inodes=>56817750, :filesystem_id=>2050, :mount_flags=>1024, :max_filename_length=>255}
-
-```
-
-### LinuxStat::Filesystem
-```
-# File:		filesystem.rb | Line: 94
-# Definition:	def available(fs = ?..freeze)
-LinuxStat::Filesystem.available(fs)
-=> 35695280128
-
-# File:		filesystem.rb | Line: 60
-# Definition:	def free(fs = ?..freeze)
-LinuxStat::Filesystem.free(fs)
-=> 35695280128
-
-# File:		filesystem.rb | Line: 21
-# Definition:	def stat(fs = ?..freeze)
-LinuxStat::Filesystem.stat(fs)
-=> {:total=>119981191168, :free=>35695280128, :used=>84285911040}
-
-# File:		filesystem.rb | Line: 110
-# Definition:	def stat_raw(fs = ?..freeze)
-LinuxStat::Filesystem.stat_raw(fs)
-=> {:block_size=>4096, :fragment_size=>4096, :blocks=>29292283, :block_free=>8714668, :block_avail_unpriv=>8714668, :inodes=>58612160, :free_inodes=>56817750, :filesystem_id=>2050, :mount_flags=>1024, :max_filename_length=>255}
-
-# File:		filesystem.rb | Line: 41
-# Definition:	def total(fs = ?..freeze)
-LinuxStat::Filesystem.total(fs)
-=> 119981191168
-
-# File:		filesystem.rb | Line: 75
-# Definition:	def used(fs = ?..freeze)
-LinuxStat::Filesystem.used(fs)
-=> 84285911040
-
-```
-
-### LinuxStat::Kernel
-```
-# File:		kernel.rb | Line: 88
-# Definition:	def build_date
-LinuxStat::Kernel.build_date()
-=> 2020-11-20 07:44:55 +0000
-
-# File:		kernel.rb | Line: 142
-# Definition:	def build_date_string
-LinuxStat::Kernel.build_date_string()
-=> "20 Nov 2020 07:44:55 +0000"
-
-# File:		kernel.rb | Line: 23
-# Definition:	def build_user
-LinuxStat::Kernel.build_user()
-=> "souravgoswami@archlinux"
-
-# File:		kernel.rb | Line: 181
-# Definition:	def ticks
-LinuxStat::Kernel.clk_tck()
-=> 100
-
-# File:		kernel.rb | Line: 35
-# Definition:	def compiler
-LinuxStat::Kernel.compiler()
-=> [:gcc, "10.2.0"]
-
-# File:		kernel.rb | Line: 57
-# Definition:	def compiler_version
-LinuxStat::Kernel.compiler_version()
-=> "10.2.0"
-
-# File:		kernel.rb | Line: 12
-# Definition:	def version
-LinuxStat::Kernel.release()
-=> "5.9.9-xanmod1-1"
-
-# File:		kernel.rb | Line: 171
-# Definition:	def string
-LinuxStat::Kernel.string()
-=> "Linux version 5.9.9-xanmod1-1 (souravgoswami@archlinux) (gcc (GCC) 10.2.0, GNU ld (GNU Binutils) 2.35.1) #1 SMP PREEMPT Fri, 20 Nov 2020 07:44:55 +0000"
-
-# File:		kernel.rb | Line: 181
-# Definition:	def ticks
-LinuxStat::Kernel.ticks()
-=> 100
-
-# File:		kernel.rb | Line: 12
-# Definition:	def version
-LinuxStat::Kernel.version()
-=> "5.9.9-xanmod1-1"
-
-```
-
-### LinuxStat::Memory
-```
-# File:		memory.rb | Line: 62
-# Definition:	def available
-LinuxStat::Memory.available()
-=> 1155372
-
-# File:		memory.rb | Line: 52
-# Definition:	def free
-LinuxStat::Memory.free()
-=> 261316
-
-# File:		memory.rb | Line: 93
-# Definition:	def percent_available
-LinuxStat::Memory.percent_available()
-=> 30.12
-
-# File:		memory.rb | Line: 82
-# Definition:	def percent_used
-LinuxStat::Memory.percent_used()
-=> 69.88
-
-# File:		memory.rb | Line: 13
-# Definition:	def stat
-LinuxStat::Memory.stat()
-=> {:total=>3836228, :used=>2680856, :available=>1155372, :percent_used=>69.88, :percent_available=>30.12}
-
-# File:		memory.rb | Line: 42
-# Definition:	def total
-LinuxStat::Memory.total()
-=> 3836228
-
-# File:		memory.rb | Line: 72
-# Definition:	def used
-LinuxStat::Memory.used()
-=> 2680856
-
-```
-
-### LinuxStat::Mounts
-```
-# File:		mounts.rb | Line: 181
-# Definition:	def device_stat(dev = root)
-LinuxStat::Mounts.device_stat(dev)
-=> {:mountpoint=>"/", :total=>119981191168, :free=>35695280128, :available=>35695280128, :used=>84285911040, :percent_used=>70.25, :percent_free=>29.75, :percent_available=>29.75}
-
-# File:		mounts.rb | Line: 139
-# Definition:	def devices_stat
-LinuxStat::Mounts.devices_stat()
-=> {"proc"=>{:mountpoint=>"/proc", :total=>0, :free=>0, :available=>0, :used=>0, :percent_used=>NaN, :percent_free=>NaN, :percent_available=>NaN}, "sys"=>{:mountpoint=>"/sys", :total=>0, :free=>0, :available=>0, :used=>0, :percent_used=>NaN, :percent_fre...
-
-# File:		mounts.rb | Line: 13
-# Definition:	def list
-LinuxStat::Mounts.list()
-=> ["proc /proc proc rw,nosuid,nodev,noexec,relatime 0 0", "sys /sys sysfs rw,nosuid,nodev,noexec,relatime 0 0", "dev /dev devtmpfs rw,nosuid,relatime,size=1892888k,nr_inodes=473222,mode=755 0 0", "run /run tmpfs rw,nosuid,nodev,relatime,mode=755 0 0", "...
-
-# File:		mounts.rb | Line: 22
-# Definition:	def list_devices
-LinuxStat::Mounts.list_devices()
-=> ["proc", "sys", "dev", "run", "/dev/sda2", "securityfs", "tmpfs", "devpts", "tmpfs", "cgroup2", "cgroup", "pstore", "none", "cgroup", "cgroup", "cgroup", "cgroup", "cgroup", "cgroup", "cgroup", "cgroup", "cgroup", "cgroup", "cgroup", "systemd-1", "hug...
-
-# File:		mounts.rb | Line: 111
-# Definition:	def list_devices_mount_point
-LinuxStat::Mounts.list_devices_mount_point()
-=> {"proc"=>"/proc", "sys"=>"/sys", "dev"=>"/dev", "run"=>"/run", "/dev/sda2"=>"/", "securityfs"=>"/sys/kernel/security", "tmpfs"=>"/run/user/1000", "devpts"=>"/dev/pts", "cgroup2"=>"/sys/fs/cgroup/unified", "cgroup"=>"/sys/fs/cgroup/perf_event", "pstore...
-
-# File:		mounts.rb | Line: 82
-# Definition:	def mount_point(dev = root)
-LinuxStat::Mounts.mount_point(dev)
-=> "/"
-
-# File:		mounts.rb | Line: 31
-# Definition:	def root
-LinuxStat::Mounts.root()
-=> "/dev/sda2"
-
-# File:		mounts.rb | Line: 40
-# Definition:	def root_fs
-LinuxStat::Mounts.root_fs()
-=> "xfs"
-
-# File:		mounts.rb | Line: 49
-# Definition:	def root_mount_options
-LinuxStat::Mounts.root_mount_options()
-=> "rw,noatime,attr2,inode64,logbufs=8,logbsize=32k,noquota"
-
-# File:		mounts.rb | Line: 58
-# Definition:	def tmpfs
-LinuxStat::Mounts.tmpfs()
-=> {"/dev/shm"=>"tmpfs /dev/shm tmpfs rw,nosuid,nodev 0 0", "/sys/fs/cgroup"=>"tmpfs /sys/fs/cgroup tmpfs ro,nosuid,nodev,noexec,size=4096k,nr_inodes=1024,mode=755 0 0", "/cache"=>"tmpfs /cache tmpfs rw,nosuid,nodev,relatime,size=2097152k 0 0", "/ramdisk...
-
-```
-
-### LinuxStat::Net
-```
-# File:		net.rb | Line: 86
-# Definition:	def usage(interval = 0.1)
-LinuxStat::Net.current_usage(interval)
-=> {:received=>2805500.0, :transmitted=>127290.0}
-
-# File:		net.rb | Line: 12
-# Definition:	def ipv4_private
-LinuxStat::Net.ipv4_private()
-=> "192.168.0.103"
-
-# File:		net.rb | Line: 27
-# Definition:	def total_bytes
-LinuxStat::Net.total_bytes()
-=> {:received=>1312151997, :transmitted=>81641336}
-
-# File:		net.rb | Line: 45
-# Definition:	def total_bytes_received
-LinuxStat::Net.total_bytes_received()
-=> 1312151997
-
-# File:		net.rb | Line: 58
-# Definition:	def total_bytes_transmitted
-LinuxStat::Net.total_bytes_transmitted()
-=> 81641336
-
-# File:		net.rb | Line: 86
-# Definition:	def usage(interval = 0.1)
-LinuxStat::Net.usage(interval)
-=> {:received=>2971440.0, :transmitted=>80020.0}
-
-```
-
-### LinuxStat::OS
-```
-# File:		os.rb | Line: 129
-# Definition:	def bits
-LinuxStat::OS.bits()
-=> 64
-
-# File:		os.rb | Line: 84
-# Definition:	def version
-LinuxStat::OS.distrib_version()
-=> "rolling"
-
-# File:		os.rb | Line: 46
-# Definition:	def distribution
-LinuxStat::OS.distribution()
-=> "Arch Linux"
-
-# File:		os.rb | Line: 117
-# Definition:	def hostname
-LinuxStat::OS.hostname()
-=> "archlinux"
-
-# File:		os.rb | Line: 202
-# Definition:	def loadavg
-LinuxStat::OS.loadavg()
-=> {1=>2.78173828125, 5=>2.96923828125, 15=>2.40185546875}
-
-# File:		os.rb | Line: 35
-# Definition:	def lsb_release
-LinuxStat::OS.lsb_release()
-=> {:LSB_VERSION=>"1.4", :DISTRIB_ID=>"Arch", :DISTRIB_RELEASE=>"rolling", :DISTRIB_DESCRIPTION=>"Arch Linux"}
-
-# File:		os.rb | Line: 100
-# Definition:	def machine
-LinuxStat::OS.machine()
-=> "x86_64"
-
-# File:		os.rb | Line: 108
-# Definition:	def nodename
-LinuxStat::OS.nodename()
-=> "archlinux"
-
-# File:		os.rb | Line: 19
-# Definition:	def os_release
-LinuxStat::OS.os_release()
-=> {:NAME=>"Arch Linux", :PRETTY_NAME=>"Arch Linux", :ID=>"arch", :BUILD_ID=>"rolling", :ANSI_COLOR=>"38;2;23;147;209", :HOME_URL=>"https://www.archlinux.org/", :DOCUMENTATION_URL=>"https://wiki.archlinux.org/", :SUPPORT_URL=>"https://bbs.archlinux.org/"...
-
-# File:		os.rb | Line: 146
-# Definition:	def uptime
-LinuxStat::OS.uptime()
-=> {:hour=>5, :minute=>33, :second=>59.77}
-
-# File:		os.rb | Line: 174
-# Definition:	def uptime_f
-LinuxStat::OS.uptime_f()
-=> 20039.77
-
-# File:		os.rb | Line: 185
-# Definition:	def uptime_i
-LinuxStat::OS.uptime_i()
-=> 20040
-
-# File:		os.rb | Line: 84
-# Definition:	def version
-LinuxStat::OS.version()
-=> "rolling"
-
-```
-
-### LinuxStat::PCI
-```
-# File:		pci.rb | Line: 216
-# Definition:	def count
-LinuxStat::PCI.count()
-=> 13
-
-# File:		pci.rb | Line: 216
-# Definition:	def count
-LinuxStat::PCI.count_devices()
-=> 13
-
-# File:		pci.rb | Line: 54
-# Definition:	def devices_info(hwdata: true)
-LinuxStat::PCI.devices_info(hwdata:)
-=> [{:id=>"8086:1904", :vendor=>"8086", :device=>"1904", :irq=>0, :kernel_driver=>"skl_uncore", :hwdata=>{:vendor=>"Intel Corporation", :product=>"Xeon E3-1200 v5/E3-1500 v5/6th Gen Core Processor Host Bridge/DRAM Registers"}}, {:id=>"8086:1916", :vendor...
-
-# File:		pci.rb | Line: 130
-# Definition:	def devices_stat(hwdata: true)
-LinuxStat::PCI.devices_stat(hwdata:)
-=> [{:path=>"/sys/bus/pci/devices/0000:00:00.0/", :id=>"8086:1904", :vendor=>"8086", :device=>"1904", :sub_vendor=>"1028", :sub_device=>"077d", :kernel_driver=>"skl_uncore", :revision=>"0x08", :irq=>0, :enable=>false, :hwdata=>{:vendor=>"Intel Corporatio...
-
-# File:		pci.rb | Line: 264
-# Definition:	def hwdata_file
-LinuxStat::PCI.hwdata_file()
-=> "/usr/share/hwdata/pci.ids"
-
-# File:		pci.rb | Line: 253
-# Definition:	def hwdata_file_set?
-LinuxStat::PCI.hwdata_file_set?()
-=> true
-
-# File:		pci.rb | Line: 280
-# Definition:	def initialize_hwdata
-LinuxStat::PCI.initialize_hwdata()
-=> false
-
-```
-
-### LinuxStat::PrettifyBytes
-```
-# File:		prettify_bytes.rb | Line: 49
-# Definition:	def convert_binary(n, precision: 2)
-LinuxStat::PrettifyBytes.convert_binary(n = 388183402613652, precision:)
-=> "353.05 tebibytes"
-
-# File:		prettify_bytes.rb | Line: 26
-# Definition:	def convert_decimal(n, precision: 2)
-LinuxStat::PrettifyBytes.convert_decimal(n = 937555692903085, precision:)
-=> "937.56 terabytes"
-
-# File:		prettify_bytes.rb | Line: 97
-# Definition:	def convert_short_binary(n, precision: 2)
-LinuxStat::PrettifyBytes.convert_short_binary(n = 542625870963586, precision:)
-=> "493.52 TiB"
-
-# File:		prettify_bytes.rb | Line: 72
-# Definition:	def convert_short_decimal(n, precision: 2)
-LinuxStat::PrettifyBytes.convert_short_decimal(n = 861937756585891, precision:)
-=> "861.94 TB"
-
-```
-
-### LinuxStat::ProcFS
-```
-LinuxStat::ProcFS.last_pid()
-=> 12587
-
-LinuxStat::ProcFS.uptime_f()
-=> 20039.98
-
-```
-
-### LinuxStat::Process
-```
-# File:		process.rb | Line: 57
-# Definition:	def cmdlines
-LinuxStat::Process.cmdlines()
-=> {1=>"/sbin/init", 2=>"", 3=>"", 4=>"", 6=>"", 9=>"", 10=>"", 11=>"", 12=>"", 13=>"", 14=>"", 15=>"", 16=>"", 17=>"", 18=>"", 19=>"", 20=>"", 21=>"", 23=>"", 24=>"", 25=>"", 26=>"", 27=>"", 28=>"", 30=>"", 31=>"", 32=>"", 33=>"", 34=>"", 35=>"", 37=>""...
-
-# File:		process.rb | Line: 29
-# Definition:	def count
-LinuxStat::Process.count()
-=> 190
-
-# File:		process.rb | Line: 120
-# Definition:	def idle
-LinuxStat::Process.idle()
-=> [3, 4, 6, 9, 12, 23, 30, 37, 39, 49, 102, 103, 104, 106, 107, 108, 109, 110, 117, 118, 119, 121, 131, 134, 135, 140, 165, 167, 170, 171, 175, 180, 181, 182, 183, 184, 185, 186, 188, 225, 232, 234, 270, 415, 419, 422, 10749, 11032, 11078, 11124, 11128,...
-
-# File:		process.rb | Line: 160
-# Definition:	def last_pid
-LinuxStat::Process.last_pid()
-=> 12587
-
-# File:		process.rb | Line: 11
-# Definition:	def list
-LinuxStat::Process.list()
-=> [1, 2, 3, 4, 6, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 27, 28, 30, 31, 32, 33, 34, 35, 37, 38, 39, 40, 41, 42, 46, 47, 48, 49, 50, 51, 52, 102, 103, 104, 106, 107, 108, 109, 110, 112, 114, 115, 117, 118, 119, 121, 131, 134,...
-
-# File:		process.rb | Line: 36
-# Definition:	def names
-LinuxStat::Process.names()
-=> {1=>"systemd", 2=>"kthreadd", 3=>"rcu_gp", 4=>"rcu_par_gp", 6=>"kworker/0:0H-kblockd", 9=>"mm_percpu_wq", 10=>"ksoftirqd/0", 11=>"rcuc/0", 12=>"rcu_preempt", 13=>"rcub/0", 14=>"migration/0", 15=>"idle_inject/0", 16=>"cpuhp/0", 17=>"cpuhp/1", 18=>"idle...
-
-# File:		process.rb | Line: 138
-# Definition:	def running
-LinuxStat::Process.running()
-=> [12583]
-
-# File:		process.rb | Line: 111
-# Definition:	def sleeping
-LinuxStat::Process.sleeping()
-=> [1, 2, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 27, 28, 31, 32, 33, 34, 35, 38, 40, 41, 42, 46, 47, 48, 50, 51, 52, 112, 114, 115, 164, 166, 189, 217, 233, 235, 307, 310, 311, 312, 313, 418, 420, 421, 424, 426, 429, 444, 447, 450, 481,...
-
-# File:		process.rb | Line: 147
-# Definition:	def stopped
-LinuxStat::Process.stopped()
-=> []
-
-# File:		process.rb | Line: 78
-# Definition:	def types
-LinuxStat::Process.types()
-=> {1=>:sleeping, 2=>:sleeping, 3=>:idle, 4=>:idle, 6=>:idle, 9=>:idle, 10=>:sleeping, 11=>:sleeping, 12=>:idle, 13=>:sleeping, 14=>:sleeping, 15=>:sleeping, 16=>:sleeping, 17=>:sleeping, 18=>:sleeping, 19=>:sleeping, 20=>:sleeping, 21=>:sleeping, 23=>:i...
-
-# File:		process.rb | Line: 129
-# Definition:	def zombie
-LinuxStat::Process.zombie()
-=> []
-
-```
-
-### LinuxStat::ProcessInfo
-```
-# File:		process_info.rb | Line: 61
-# Definition:	def cmdline(pid = $$)
-LinuxStat::ProcessInfo.cmdline(pid)
-=> "/usr/bin/ruby /home/sourav/.gem/ruby/2.7.0/bin/linuxstat.rb -md"
-
-# File:		process_info.rb | Line: 87
-# Definition:	def command_name(pid = $$)
-LinuxStat::ProcessInfo.command_name(pid)
-=> "ruby"
-
-# File:		process_info.rb | Line: 654
-# Definition:	def nproc(pid = $$)
-LinuxStat::ProcessInfo.count_cpu(pid)
-=> 4
 
-# File:		process_info.rb | Line: 280
-# Definition:	def cpu_stat(pid: $$, sleep: ticks_to_ms_t5)
-LinuxStat::ProcessInfo.cpu_stat(pid:, sleep:)
-=> {:cpu_usage=>0.0, :threads=>0, :last_executed_cpu=>0}
+Following are the LinuxStat modules and module functions in a table.
+Usages.md is generated by `linuxstat.rb -md` command, which is available after the installation.
 
-# File:		process_info.rb | Line: 340
-# Definition:	def cpu_usage(pid: $$, sleep: ticks_to_ms_t5)
-LinuxStat::ProcessInfo.cpu_usage(pid:, sleep:)
-=> 0.0
-
-# File:		process_info.rb | Line: 496
-# Definition:	def gid(pid = $$)
-LinuxStat::ProcessInfo.gid(pid)
-=> {:real=>1000, :effective=>1000, :saved_set=>1000, :filesystem_uid=>1000}
-
-# File:		process_info.rb | Line: 462
-# Definition:	def last_executed_cpu(pid = $$)
-LinuxStat::ProcessInfo.last_executed_cpu(pid)
-=> 1
-
-# File:		process_info.rb | Line: 151
-# Definition:	def mem_stat(pid = $$)
-LinuxStat::ProcessInfo.mem_stat(pid)
-=> {:memory=>24576000, :virtual_memory=>96206848, :resident_memory=>30736384, :shared_memory=>6160384}
-
-# File:		process_info.rb | Line: 171
-# Definition:	def memory(pid = $$)
-LinuxStat::ProcessInfo.memory(pid)
-=> 24576.0
-
-# File:		process_info.rb | Line: 624
-# Definition:	def nice(pid = $$)
-LinuxStat::ProcessInfo.nice(pid)
-=> 0
-
-# File:		process_info.rb | Line: 654
-# Definition:	def nproc(pid = $$)
-LinuxStat::ProcessInfo.nproc(pid)
-=> 4
-
-# File:		process_info.rb | Line: 517
-# Definition:	def owner(pid = $$)
-LinuxStat::ProcessInfo.owner(pid)
-=> "sourav"
-
-# File:		process_info.rb | Line: 112
-# Definition:	def process_name(pid = $$)
-LinuxStat::ProcessInfo.process_name(pid)
-=> "linuxstat.rb"
-
-# File:		process_info.rb | Line: 213
-# Definition:	def resident_memory(pid = $$)
-LinuxStat::ProcessInfo.resident_memory(pid)
-=> 30736.384
-
-# File:		process_info.rb | Line: 586
-# Definition:	def running_time(pid = $$)
-LinuxStat::ProcessInfo.running_time(pid)
-=> 1.02
-
-# File:		process_info.rb | Line: 234
-# Definition:	def shared_memory(pid = $$)
-LinuxStat::ProcessInfo.shared_memory(pid)
-=> 6160.384
-
-# File:		process_info.rb | Line: 567
-# Definition:	def start_time(pid = $$)
-LinuxStat::ProcessInfo.start_time(pid)
-=> 2021-02-01 16:58:34 +0530
-
-# File:		process_info.rb | Line: 539
-# Definition:	def start_time_epoch(pid = $$)
-LinuxStat::ProcessInfo.start_time_epoch(pid)
-=> 1612178914
-
-# File:		process_info.rb | Line: 611
-# Definition:	def state(pid = $$)
-LinuxStat::ProcessInfo.state(pid)
-=> "R"
-
-# File:		process_info.rb | Line: 392
-# Definition:	def thread_usage(pid: $$, sleep: ticks_to_ms_t5)
-LinuxStat::ProcessInfo.thread_usage(pid:, sleep:)
-=> 0.0
-
-# File:		process_info.rb | Line: 441
-# Definition:	def threads(pid = $$)
-LinuxStat::ProcessInfo.threads(pid)
-=> 1
-
-# File:		process_info.rb | Line: 30
-# Definition:	def total_io(pid = $$)
-LinuxStat::ProcessInfo.total_io(pid)
-=> {:read_bytes=>1245184, :write_bytes=>0}
-
-# File:		process_info.rb | Line: 472
-# Definition:	def uid(pid = $$)
-LinuxStat::ProcessInfo.uid(pid)
-=> {:real=>1000, :effective=>1000, :saved_set=>1000, :filesystem_uid=>1000}
-
-# File:		process_info.rb | Line: 192
-# Definition:	def virtual_memory(pid = $$)
-LinuxStat::ProcessInfo.virtual_memory(pid)
-=> 96206.848
-
-```
-
-### LinuxStat::Swap
-```
-# File:		swap.rb | Line: 24
-# Definition:	def any?
-LinuxStat::Swap.any?()
-=> true
-
-# File:		swap.rb | Line: 81
-# Definition:	def available
-LinuxStat::Swap.available()
-=> 3856636
-
-# File:		swap.rb | Line: 70
-# Definition:	def free
-LinuxStat::Swap.free()
-=> 3856636
-
-# File:		swap.rb | Line: 10
-# Definition:	def list
-LinuxStat::Swap.list()
-=> {"/dev/zram0"=>[:partition, 4194300, 337664, -2]}
-
-# File:		swap.rb | Line: 116
-# Definition:	def percent_available
-LinuxStat::Swap.percent_available()
-=> 91.95
-
-# File:		swap.rb | Line: 102
-# Definition:	def percent_used
-LinuxStat::Swap.percent_used()
-=> 8.05
-
-# File:		swap.rb | Line: 34
-# Definition:	def stat
-LinuxStat::Swap.stat()
-=> {:total=>4194300, :used=>337664, :available=>3856636, :percent_used=>8.05, :percent_available=>91.95}
-
-# File:		swap.rb | Line: 59
-# Definition:	def total
-LinuxStat::Swap.total()
-=> 4194300
-
-# File:		swap.rb | Line: 93
-# Definition:	def used
-LinuxStat::Swap.used()
-=> 337664
-
-```
-
-### LinuxStat::Sysconf
-```
-LinuxStat::Sysconf.child_max()
-=> 14788
-
-LinuxStat::Sysconf.expr_nest_max()
-=> 32
-
-LinuxStat::Sysconf.get_euid()
-=> 1000
-
-LinuxStat::Sysconf.get_gid()
-=> 1000
-
-LinuxStat::Sysconf.get_login()
-=> "sourav"
-
-LinuxStat::Sysconf.get_uid()
-=> 1000
-
-LinuxStat::Sysconf.get_user()
-=> "sourav"
-
-LinuxStat::Sysconf.hostname()
-=> "archlinux"
-
-LinuxStat::Sysconf.hostname_max()
-=> 64
-
-LinuxStat::Sysconf.line_max()
-=> 2048
-
-LinuxStat::Sysconf.login_name_max()
-=> 256
-
-LinuxStat::Sysconf.open_max()
-=> 1024
-
-LinuxStat::Sysconf.pagesize()
-=> 4096
-
-LinuxStat::Sysconf.posix_version()
-=> 200809
-
-LinuxStat::Sysconf.processor_configured()
-=> 4
-
-LinuxStat::Sysconf.processor_online()
-=> 4
-
-LinuxStat::Sysconf.sc_clk_tck()
-=> 100
-
-LinuxStat::Sysconf.stream_max()
-=> 16
-
-LinuxStat::Sysconf.tty_name_max()
-=> 32
-
-```
-
-### LinuxStat::Sysinfo
-```
-LinuxStat::Sysinfo.bufferram()
-=> 4096
-
-LinuxStat::Sysinfo.freehigh()
-=> 0
-
-LinuxStat::Sysinfo.freeram()
-=> 251408384
-
-LinuxStat::Sysinfo.freeswap()
-=> 3949195264
-
-LinuxStat::Sysinfo.loads()
-=> [2.78173828125, 2.96923828125, 2.40185546875]
-
-LinuxStat::Sysinfo.sharedram()
-=> 606461952
-
-LinuxStat::Sysinfo.stat()
-=> {:totalram=>3928297472, :freeram=>251408384, :sharedram=>606461952, :bufferram=>4096, :totalswap=>4294963200, :freeswap=>3949195264, :totalhigh=>0, :freehigh=>0, :uptime=>20041, :loads=>[2.78173828125, 2.96923828125, 2.40185546875]}
-
-LinuxStat::Sysinfo.totalhigh()
-=> 0
-
-LinuxStat::Sysinfo.totalram()
-=> 3928297472
-
-LinuxStat::Sysinfo.totalswap()
-=> 4294963200
-
-LinuxStat::Sysinfo.uptime()
-=> 20041
-
-```
-
-### LinuxStat::Thermal
-```
-# File:		thermal.rb | Line: 59
-# Definition:	def count_fans
-LinuxStat::Thermal.count_fans()
-=> 1
-
-# File:		thermal.rb | Line: 49
-# Definition:	def count_sensors
-LinuxStat::Thermal.count_sensors()
-=> 8
-
-# File:		thermal.rb | Line: 41
-# Definition:	def fans
-LinuxStat::Thermal.fans()
-=> [{:path=>"/sys/class/hwmon/hwmon4", :name=>"dell_smm", :label=>"Processor Fan", :rpm=>2785}]
-
-# File:		thermal.rb | Line: 23
-# Definition:	def temperatures
-LinuxStat::Thermal.temperatures()
-=> [{:path=>"/sys/class/hwmon/hwmon4", :name=>"dell_smm", :label=>"SODIMM", :temperature=>34.0}, {:path=>"/sys/class/hwmon/hwmon4", :name=>"dell_smm", :label=>"CPU", :temperature=>43.0}, {:path=>"/sys/class/hwmon/hwmon4", :name=>"dell_smm", :label=>"Ambi...
-
-```
-
-### LinuxStat::USB
-```
-# File:		usb.rb | Line: 139
-# Definition:	def count
-LinuxStat::USB.count()
-=> 10
-
-# File:		usb.rb | Line: 139
-# Definition:	def count
-LinuxStat::USB.count_devices()
-=> 10
-
-# File:		usb.rb | Line: 49
-# Definition:	def devices_stat(hwdata: true)
-LinuxStat::USB.devices_stat(hwdata:)
-=> [{:path=>"/sys/bus/usb/devices/1-1.2/", :id=>"04d9:1203", :vendor_id=>"04d9", :product_id=>"1203", :bus_num=>1, :dev_num=>7, :hwdata=>{:vendor=>"Holtek Semiconductor, Inc.", :product=>"Keyboard"}, :authorized=>true, :b_max_power=>"100mA", :b_max_packe...
-
-# File:		usb.rb | Line: 179
-# Definition:	def hwdata_file
-LinuxStat::USB.hwdata_file()
-=> "/usr/share/hwdata/usb.ids"
-
-# File:		usb.rb | Line: 168
-# Definition:	def hwdata_file_set?
-LinuxStat::USB.hwdata_file_set?()
-=> true
-
-# File:		usb.rb | Line: 195
-# Definition:	def initialize_hwdata
-LinuxStat::USB.initialize_hwdata()
-=> false
-
-```
-
-### LinuxStat::Uname
-```
-LinuxStat::Uname.machine()
-=> "x86_64"
-
-LinuxStat::Uname.nodename()
-=> "archlinux"
-
-LinuxStat::Uname.release()
-=> "5.9.9-xanmod1-1"
-
-LinuxStat::Uname.sysname()
-=> "Linux"
-
-LinuxStat::Uname.version()
-=> "#1 SMP PREEMPT Fri, 20 Nov 2020 07:44:55 +0000"
-
-```
-
-### LinuxStat::User
-```
-# File:		user.rb | Line: 101
-# Definition:	def get_user
-LinuxStat::User.get_current_user()
-=> "sourav"
-
-# File:		user.rb | Line: 140
-# Definition:	def get_euid
-LinuxStat::User.get_euid()
-=> 1000
-
-# File:		user.rb | Line: 132
-# Definition:	def get_gid
-LinuxStat::User.get_gid()
-=> 1000
-
-# File:		user.rb | Line: 155
-# Definition:	def get_login
-LinuxStat::User.get_login()
-=> "sourav"
-
-# File:		user.rb | Line: 124
-# Definition:	def get_uid
-LinuxStat::User.get_uid()
-=> 1000
-
-# File:		user.rb | Line: 101
-# Definition:	def get_user
-LinuxStat::User.get_user()
-=> "sourav"
-
-# File:		user.rb | Line: 218
-# Definition:	def gid_by_username(username = get_user)
-LinuxStat::User.gid_by_username(username)
-=> 1000
-
-# File:		user.rb | Line: 58
-# Definition:	def gids
-LinuxStat::User.gids()
-=> {:root=>0, :bin=>1, :daemon=>2, :mail=>12, :ftp=>11, :http=>33, :nobody=>65534, :dbus=>81, :"systemd-journal-remote"=>982, :"systemd-network"=>981, :"systemd-resolve"=>980, :"systemd-timesync"=>979, :"systemd-coredump"=>978, :uuidd=>68, :avahi=>977, :...
-
-# File:		user.rb | Line: 317
-# Definition:	def home_by_gid(id = get_gid)
-LinuxStat::User.home_by_gid(id)
-=> "/home/sourav"
-
-# File:		user.rb | Line: 269
-# Definition:	def home_by_username(user = get_user)
-LinuxStat::User.home_by_username(user)
-=> "/home/sourav"
-
-# File:		user.rb | Line: 75
-# Definition:	def home_directories
-LinuxStat::User.home_directories()
-=> {:root=>"/root", :bin=>"/", :daemon=>"/", :mail=>"/var/spool/mail", :ftp=>"/srv/ftp", :http=>"/srv/http", :nobody=>"/", :dbus=>"/", :"systemd-journal-remote"=>"/", :"systemd-network"=>"/", :"systemd-resolve"=>"/", :"systemd-timesync"=>"/", :"systemd-c...
-
-# File:		user.rb | Line: 296
-# Definition:	def homes_by_uid(id = get_uid)
-LinuxStat::User.homes_by_uid(id)
-=> ["/home/sourav"]
-
-# File:		user.rb | Line: 25
-# Definition:	def ids
-LinuxStat::User.ids()
-=> {:root=>{:uid=>0, :gid=>0}, :bin=>{:uid=>1, :gid=>1}, :daemon=>{:uid=>2, :gid=>2}, :mail=>{:uid=>8, :gid=>12}, :ftp=>{:uid=>14, :gid=>11}, :http=>{:uid=>33, :gid=>33}, :nobody=>{:uid=>65534, :gid=>65534}, :dbus=>{:uid=>81, :gid=>81}, :"systemd-journal...
-
-# File:		user.rb | Line: 13
-# Definition:	def list
-LinuxStat::User.list()
-=> ["root", "bin", "daemon", "mail", "ftp", "http", "nobody", "dbus", "systemd-journal-remote", "systemd-network", "systemd-resolve", "systemd-timesync", "systemd-coredump", "uuidd", "avahi", "colord", "git", "lxdm", "polkitd", "rtkit", "usbmux", "sourav...
-
-# File:		user.rb | Line: 247
-# Definition:	def uid_by_username(username = get_user)
-LinuxStat::User.uid_by_username(username)
-=> 1000
-
-# File:		user.rb | Line: 42
-# Definition:	def uids
-LinuxStat::User.uids()
-=> {:root=>0, :bin=>1, :daemon=>2, :mail=>8, :ftp=>14, :http=>33, :nobody=>65534, :dbus=>81, :"systemd-journal-remote"=>982, :"systemd-network"=>981, :"systemd-resolve"=>980, :"systemd-timesync"=>979, :"systemd-coredump"=>978, :uuidd=>68, :avahi=>977, :c...
-
-# File:		user.rb | Line: 190
-# Definition:	def username_by_gid(gid = get_gid)
-LinuxStat::User.username_by_gid(gid)
-=> "sourav"
-
-# File:		user.rb | Line: 172
-# Definition:	def usernames_by_uid(uid = get_uid)
-LinuxStat::User.usernames_by_uid(uid)
-=> ["sourav"]
-
-```
+For ease of use, LinuxStat is also assigned to the LS constant.
+So LinuxStat::USB can be replaced with LS::USB for example.
+
+| LinuxStat Module | Description |
+|:---|:---|
+| [LinuxStat::BIOS](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatbios) | System's BIOS related informaion |
+| [LinuxStat::Battery](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatbattery) | System's first Battery realted information |
+| [LinuxStat::CPU](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatcpu) | System's CPU usage and other related information |
+| [LinuxStat::FS](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatfs) | System's file system related information. It's used by Filesystem module. |
+| [LinuxStat::Filesystem](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatfilesystem) | System's file system usage and other related information |
+| [LinuxStat::Kernel](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatkernel) | System's kernel related information |
+| [LinuxStat::Memory](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatmemory) | System's memory (RAM) usage and other related information |
+| [LinuxStat::Mounts](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatmounts) | System's mount point related information |
+| [LinuxStat::Net](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatnet) | System's internet usage and other information |
+| [LinuxStat::OS](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatos) | System's OS related information and parse release files |
+| [LinuxStat::PCI](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatpci) | System's PCI device related information (optional parsing of hwdata) |
+| [LinuxStat::PrettifyBytes](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatprettifybytes) | Convert bytes into human readable format (kB, kiB, etc.) |
+| [LinuxStat::ProcFS](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatprocfs) | Read proc file system in C for faster access. Used accross |
+| [LinuxStat::Process](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatprocess) | System's processes and related information |
+| [LinuxStat::ProcessInfo](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatprocessinfo)   | System's single process CPU, memory usages, CPU time, etc. info |
+| [LinuxStat::Swap](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatswap) | System's swap related information |
+| [LinuxStat::Sysconf](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatsysconf) | Used by other LinuxStat modules, provides various system details like pagesize, max children, open files, etc |
+| [LinuxStat::Sysinfo](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatsysinfo) | Used by other LinuxStat modules, faster access to information like totalram, freeram, totalhigh, load average, etc. |
+| [LinuxStat::Thermal](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatthermal) | System's thermal status, fan related info, sensor count, fan count, etc. |
+| [LinuxStat::USB](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatusb) | System's USB device related information and other counts (optional parsing of hwdata) |
+| [LinuxStat::Uname](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatuname) | Used by other LinuxStat modules, System's Uname information in C, that's also provided by the `uname` command. |
+| [LinuxStat::User](https://github.com/Souravgoswami/linux_stat/blob/master/Usages.md#linuxstatuser) | Systems' various user related information, provides current user name, home directory, etc. |
 
 ---
 
+# Notes
+
 ## Note 1: CPU usage, and Net usage
 To calculate the current usage, we need to get two usages at a given interval, and subtract the 2nd from the 1st.
 For example, if the current download (`LinuxStat::Net.total_bytes_received`) is 1000 bytes, and if 0.1 seconds ago, it was 100 bytes, that means 900 bytes was received in 0.1 seconds.
@@ -1760,3 +768,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Sourav
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Languages
+
+<img src="https://linuxstatloc.herokuapp.com/svg" width="260px">