Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
- Updated README to include Contributors page.
- Minor fixes on typos and formatting.
  • Loading branch information
galoget authored and sni committed Jul 5, 2023
1 parent fc5fb28 commit 8b4e902
Showing 1 changed file with 22 additions and 9 deletions.
31 changes: 22 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,24 @@ Thruk is a multibackend monitoring webinterface which currently
supports Naemon, Icinga, Shinken and Nagios as backend using the Livestatus
API. It is designed to be a 'dropin' replacement and covers the original
features plus adds additional enhancements for large installations, increased
usability and many usefull addons.
usability and many useful addons.

![Thruk Startpage](https://thruk.org/images/galleries/01_main-thumb.png "Thruk Startpage")
![Thruk Panorama](https://thruk.org/images/galleries/geomaps-thumb.png "Thruk Panorama")

[See more screenshots...](https://thruk.org/screenshots/)

Documentation
-------------
All documentation is under docs/
All documentation is under `docs/`

Support
-------

* Ask a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/thruk)
* Mailing list on [Google Groups](https://groups.google.com/group/thruk).
* File a bug in [GitHub Issues](https://github.com/sni/Thruk/issues).
* File a Bug in [GitHub Issues](https://github.com/sni/Thruk/issues).
* Report a Security Advisory [GitHub Security](https://github.com/sni/Thruk/security).
* [Tweet](https://twitter.com/ThrukGUI/) us with other feedback.
* Chat with developers on [IRC Libera #thruk](irc://irc.libera.chat/thruk) ([Webchat](https://web.libera.chat/?nick=Guest?#thruk)).

Expand All @@ -32,7 +34,7 @@ Main Features / Advantages
* Faster while using less CPU
* Displays live data, no delay between core and GUI
* Clusterable, can be clustered over hosts
* Business Process Addon
* Business Process Add-on
* Advanced status filters
* Extended logfile search
* Multiple themes included
Expand All @@ -48,13 +50,24 @@ Main Features / Advantages
* Independant from monitoring core, can be installed on remote host
* Easy to extend with plugins

### Contributions

Thanks to all the amazing [community contributors for sending PRs](https://github.com/sni/Thruk/graphs/contributors) and keeping this project updated. :heart:

If you have an idea or some kind of improvement, you are welcome to contribute and participate in the Project, feel free to send your PR.

<p align="center">
<a href="https://github.com/sni/Thruk/graphs/contributors">
<img src="https://contrib.rocks/image?repo=sni/Thruk&max=500">
</a>
</p>


License
-------

Thruk is Copyright (c) 2009-present by Sven Nierlein and others.
This is free software; you can redistribute it and/or modify it under the
same terms as the Perl5 programming language system
itself:
This is free software; you can redistribute it and/or modify it under the same terms as the Perl5 programming language system itself:

a) the "Artistic License 1.0" as published by The Perl Foundation
http://dev.perl.org/licenses/artistic.html
Expand All @@ -65,5 +78,5 @@ b) the GNU General Public License as published by the Free Software Foundation;

`SPDX-License-Identifier: Artistic-1.0-Perl OR GPL-1.0-or-later`

Vendor specific libraries below ./root/thruk/vendor/ may have different
licenes. See THANKS file for details.
Vendor specific libraries below `./root/thruk/vendor/` may have different
licenes. See `THANKS` file for details.

0 comments on commit 8b4e902

Please sign in to comment.