Merge pull request #4 from AtelierArith/terasaki/define-monitor

Define `monitor` function as entrypoint

README.md

@@ -96,15 +96,15 @@ Alternatively, you can launch the functionality directly from Julia:
 
 ```julia
 $ julia --project
-julia> using TerminalSystemMonitor: main; main()
+julia> using TerminalSystemMonitor; monitor()
 ```
 
 ### Monitoring GPU Usage
 
 Please load `CUDA.jl` package in advance:
 
 ```julia
-julia> using CUDA; using TerminalSystemMonitor: main; main()
+julia> using CUDA; using TerminalSystemMonitor; monitor()
 ```
 
 ## Why not `htop`?
@@ -117,15 +117,21 @@ julia> using Htop_jll; run(Htop_jll.htop())
 
 However, `Htop_jll` only supports Unix-based systems. The TerminalSystemMonitor.jl package also supports Windows as long as Term.jl and UnicodePlots.jl are available on the platform.
 
-## Why not `bottom`?
+## Why not `btm`?
 
 You can also use [ClementTsang/bottom](https://github.com/ClementTsang/bottom), also known as the `btm` command:
 
+```sh
+$ btm -b
 ```
-btm -b
+
+We could use `bottom_jll` instead:
+
+```julia
+julia> using bottom_jll; run(`$(btm()) --basic`)
 ```
 
-However, our Julia package [TerminalSystemMonitor.jl](https://github.com/AtelierArith/TerminalSystemMonitor.jl) offers a cross-platform solution that integrates directly with Julia, providing similar functionality in a familiar environment.
+Our Julia package [TerminalSystemMonitor.jl](https://github.com/AtelierArith/TerminalSystemMonitor.jl) offers a cross-platform solution and adopts responsive design; chaging layout nicely based on your terminal size.
 
 ## Can I visualize GPU Apple Silicon processors?
 

src/TerminalSystemMonitor.jl

@@ -5,6 +5,8 @@ using UnicodePlots
 import Term # this is required by UnicodePlots.panel
 using MLDataDevices: MLDataDevices, CUDADevice
 
+export monitor # entrypoint from REPL
+
 # These function will be defined in Package extensions
 function plot_gpu_utilization_rates end
 function plot_gpu_memory_utilization end
@@ -129,6 +131,10 @@ function plot_cpu_memory_utilization()
 
 end
 
+function monitor(args...)
+    main(args...)
+end
+
 function main(dummyargs...)
     hidecursor()