summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md15
1 files changed, 13 insertions, 2 deletions
diff --git a/README.md b/README.md
index 6aab23d..4f066e4 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,13 @@
-# syskill
-A utility that will help you beautifully deal with your *NIX system. Do not use them on the main system or in production (if you still need them)
+# *NIX suicide kit
+A utility that will help you beautifully deal with your *NIX system.
+
+> [!WARNING]
+> DONT USE THIS ON PRODUCTION OR REAL PC, SOME FUNCTIONS MAY CAUSE YOUR SYSTEM TO BECOME COMPLETELY UNSTABLE.
+> But when calling a function located in `src/non-critical/`, all the consequences will go away after a reboot.
+
+This package provides a CLI utility with a set of functions for mocking your operating system, both critical and non-critical. From the already familiar fork bombs `:(){ :|:& };:` or something more critical like `sudo rm -rf /* --no-preserve-root` before rendering graphic artifacts by interfering with the frame buffer.
+
+I also neglected optimization in this project. Seriously, what kind of optimization and code cleanliness are you talking about in a project that's literally designed to consolidate all possible ways to abuse or kill your system into one?
+
+Most of the functions have been rewritten to suit the features of different UNIX-like systems (FreeBSD, OpenBSD, linux, etc...).
+In the future, an addition to the project is planned in the form of similar abilities but for `win32`