diff --git a/README.md b/README.md index f3a574a..e838700 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # monipy - A infrastructure monitoring toolchain -This is implemented in an old school way for easy understanding without cloud -and such stuff... Hope it will become useful someday for somebody and not only for +This is implemented in an old school way for easy understanding without cloud +and such stuff... Hope it will become useful someday for somebody and not only for me. ## About @@ -17,41 +17,39 @@ nearly does not exist. ### Manifest - - All of this project **must be MIT licensed**. When using 3rd party libraries make -sure the license is compatible but MIT should always be preferred if an -alternative is available. - - - The core of monipy/monipyd should not use 3rd party libraries. only plugins, -notifications and types may use other libraries. But coping code into the -source tree is ok when respecting the license. Not using 3rd party libraries -should always be preferred though. - - - Inline comment should be all lowercase. Descriptions and documentation comments -must be natural language. +- All of this project **must be MIT licensed**. When using 3rd party libraries make + sure the license is compatible but MIT should always be preferred if an + alternative is available. +- The core of monipy/monipyd should not use 3rd party libraries. only plugins, + notifications and types may use other libraries. But coping code into the + source tree is ok when respecting the license. Not using 3rd party libraries + should always be preferred though. +- Inline comment should be all lowercase. Descriptions and documentation comments + must be natural language. ### To do -**Everything!** :) Just outlining the idea and creating code and structure skeletons +**Everything!** :) Just outlining the idea and creating code and structure skeletons at the moment! ### Version numbering -According to: [https://wiki.unixpeople.org/linux_kernel_version_numbering]() +According to: [https://wiki.unixpeople.org/linux_kernel_version_numbering](https://wiki.unixpeople.org/linux_kernel_version_numbering) **MAJOR**.**FEATURE**.**MINOR**.**FIXES** - - **MAJOR** changes _can_ change the API. The lesser, the better. - - **FEATURE** changes can, but _should_ not break the API. New features are placed -here. It _expects_ a complete documentation. - - **MINOR** changes are "just-in-time" changes or small enhancements which _must_ -not affect the documentation and _must_ not break the API. - - **FIXES** _must_ never affect anything else then stability or security. +- **MAJOR** changes _can_ change the API. The lesser, the better. +- **FEATURE** changes can, but _should_ not break the API. New features are placed + here. It _expects_ a complete documentation. +- **MINOR** changes are "just-in-time" changes or small enhancements which _must_ + not affect the documentation and _must_ not break the API. +- **FIXES** _must_ never affect anything else then stability or security. ## License ### MIT License -Copyright (c) 2022 Johannes Findeisen +Copyright (c) 2022 Johannes Findeisen - you@hanez.org Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal