Init

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing to the Project
+
+We welcome contributions from the community to help improve the project. Whether you're interested in fixing bugs, adding new features, improving documentation, or providing recommendations, your contributions are valuable to us.
+
+## Ways to Contribute
+
+You can contribute to the project in the following ways:
+
+- **Create Issues**: Feel free to create issues for feature requests, bug fixes, documentation improvements, or any recommendations you may have.
+- **Forks and Merge Requests**: Fork the repository, make your changes, and submit a merge request with a clear explanation of the changes you've made and why they're necessary.
+
+## Guidelines for Contributions
+
+When contributing to the project, please adhere to the following guidelines:
+
+- **Be Respectful**: Treat other contributors and users with respect and courtesy.
+- **Follow Code of Conduct**: Follow the project's code of conduct to maintain a friendly and inclusive environment.
+- **Provide Detailed Explanations**: Clearly explain the purpose of your contribution, whether it's a new feature, bug fix, documentation update, or recommendation.
+- **Follow Coding Standards**: If you're contributing code, adhere to the project's coding standards and conventions.
+- **Test Your Changes**: Ensure that your changes are thoroughly tested before submitting them.
+
+## Rules for Contributions
+
+To ensure a smooth contribution process, please keep the following rules in mind:
+
+- **License Awareness**: Be aware of and check the LICENSE file before contributing to understand the project's licensing terms.
+- **Respect License Terms**: Ensure that your contributions comply with the project's license terms.
+- **Avoid Plagiarism**: Do not plagiarize code or content from other sources. All contributions should be original work or properly attributed.
+
+## Get Started
+
+Ready to contribute? Start by creating an issue or fork the repository to begin making your changes. We appreciate your contributions and look forward to working with you to improve the project.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 NobleMajo
+Copyright (c) 2024 Majo Richter (NobleMajo)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -0,0 +1,53 @@
+# Table of Contents
+- [Table of Contents](#table-of-contents)
+- [About](#about)
+- [Key Features](#key-features)
+- [Requirements](#requirements)
+- [Getting started](#getting-started)
+- [Technologies](#technologies)
+- [License](#license)
+- [Contributing](#contributing)
+- [Disclaimer](#disclaimer)
+
+# About
+HiveLib simplifies SSH2 connections via promise-based task execution on Linux servers with built-in server utilities and powerful command execution functions.
+
+HiveLib is a library designed to streamline SSH2 connections and task execution on Linux servers. It provides user-friendly promise-based functions for efficient server operations without the need for a client application.
+
+# Key Features
+HiveLib offers the following key features:
+- __All-Distributions__: SSH2 and SFTP operations for all Linux servers
+- __Promisified__: Promise-based functions for ease of use
+- __AbstractPackageManager__: Built-in abstract package manager with support for apt, dnf, and yum, with additional configurability
+- __Exec__: Command execution utilities for event or promise-based error handling and output parsing, filtering, and mapping
+
+# Requirements
+HiveLib requires the following server environments:
+- **SSH2 server**
+- **SFTP support**
+- **Linux distribution**
+
+# Getting started
+
+```ts
+//coming soon
+import {}
+```
+
+# Technologies
+HiveLib is built using the following technologies:
+- **TypeScript**
+- **Node.js**
+- **SSH2**
+- **SFTP**
+
+# License
+HiveLib is licensed under the MIT license, providing users with flexibility and freedom to use and modify the software according to their needs.
+
+# Contributing
+Contributions to HiveLib are welcome!  
+Interested users can refer to the guidelines provided in the CONTRIBUTING.md file to contribute to the project and help improve its functionality and features.
+
+# Disclaimer
+HiveLib is provided without warranties.  
+Users are advised to review the accompanying license for more information on the terms of use and limitations of liability.