Skip to content

Commit

Permalink
bumped version
Browse files Browse the repository at this point in the history
  • Loading branch information
Amith Koujalgi committed Aug 25, 2023
1 parent 0685705 commit 1e864ad
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 16 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ An open-source Python tool to provide system stats over a web interface.

![](https://img.shields.io/badge/Python-3.8%2B-blue.svg)

![](https://img.shields.io/badge/sys--stats:_latest_version-0.0.8-green.svg)
![](https://img.shields.io/badge/sys--stats:_latest_version-0.0.9-green.svg)

Project Website: https://amithkoujalgi.github.io/sys-stats/

Expand Down
38 changes: 24 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,22 +51,32 @@ The development of that thought, resulted in a tool that is:
- **Has Cross-Platform support:** Compatible with various operating
systems, including macOS, and Linux.

For whom is this tool intended?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

While this tool could be used by anybody who is interested in simple
system monitoring, it is best suited for developers or system admins or
someone who wants to monitor a headless (remote server/non-windowed mode
server) computer which over a web interface.

Where can I run this?
~~~~~~~~~~~~~~~~~~~~~

While it can be run practically on any \*nix systems, it’s best suited
for running on systems that run headless ( server/non-windowed mode) or
remotely which need monitoring over the web. For example:
It can practically run on any system, and due to its lightweight nature,
it can operate on computers with low resource specifications.

- you can set it up on docker containers which need to be monitored
remotely.
Some of the use-cases:

- you can set it up on Docker containers which need to be monitored
remotely.
- if you have multiple on-prem servers in a private network that need
monitoring at individual host level, you can host this tool on each
server and access it over web interface.
- you can run it on a Raspberry Pi (potentially?). Although I’ve not
tested the tool on a Raspberry platform 😅

The possibilities are endless. The tool will evolve over time to get
better.
The possibilities are endless and the tool will evolve over time to get
better.

Features
~~~~~~~~
Expand Down Expand Up @@ -116,9 +126,9 @@ Screenshots

Listing processes |image3|

Resource utilisation |image4|
List of processes listening on inet ports |image4|

List of processes listening on inet ports |image5|
Resource utilisation |image5|

Development
~~~~~~~~~~~
Expand Down Expand Up @@ -161,7 +171,7 @@ Get Involved

Contributions are most welcome! Whether it’s reporting a bug, proposing
an enhancement, or helping with code - any sort of contribution is much
appreciated. Please refer to the contribution guidelines to get started.
appreciated.

License
~~~~~~~
Expand All @@ -170,7 +180,7 @@ The project is released under the MIT License. For more details, consult
the `License <./LICENSE>`__ file.

.. |image1| image:: https://img.shields.io/badge/Python-3.8%2B-blue.svg
.. |image2| image:: https://img.shields.io/badge/sys--stats:_latest_version-0.0.8-green.svg
.. |image3| image:: images/processes.png
.. |image4| image:: images/resources.png
.. |image5| image:: images/ports.png
.. |image2| image:: https://img.shields.io/badge/sys--stats:_latest_version-0.0.9-green.svg
.. |image3| image:: https://i.imgur.com/pdHLGi6.png
.. |image4| image:: https://i.imgur.com/8424Kt4.png
.. |image5| image:: https://i.imgur.com/VabIFk9.png
2 changes: 1 addition & 1 deletion version.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"MAJOR": 0, "MINOR": 0, "MICRO": 8}
{"MAJOR": 0, "MINOR": 0, "MICRO": 9}

0 comments on commit 1e864ad

Please sign in to comment.