docs

CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at {{ email }}. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

Makefile

@@ -1,15 +1,3 @@
-args = `arg="$(filter-out $@,$(MAKECMDGOALS))" && echo $${arg:-${1}}`
-
-CONFIG_FILE=
-
-
-
-build-docker: build-docker-lbot build-docker-agent
-
-build-docker-lbot:
-	docker build -t lbot -f docker/Dockerfile.lbot .
-build-docker-agent:
-	docker build -t lbot-agent -f docker/Dockerfile.agent .
 
 build-dev:
 	# only your platform
@@ -19,18 +7,4 @@ build-all:
 	# only your platform
 	goreleaser build --snapshot --clean
 
-run-docker-lbot:
-	@docker run --net=host -t --rm lbot $(call args,)
-run-docker-lbot-config:
-	docker run --net=host -i --rm lbot config --stdin < $(CONFIG_FILE)
-
-run-docker-agent:
-	docker run -p 1234:1234 -t --rm lbot-agent
-
-
-NEXT_VERSION=$(shell svu next)
-release:
-	git tag -a $(NEXT_VERSION) -m "Release $(NEXT_VERSION)"
-
-
-.PHONY: build-docker build-docker-agent build-docker-lbot run-docker-lbot run-docker-agent
+.PHONY: build-dev build-all

README.md

@@ -1,40 +1,57 @@
-# lbot - workload database driver (currently supporting only MongoDB)
+# loadbot 
 
 ## Introduction
-The purpose of this tool is to simulate workloads to facilitate testing the failover capabilities of database cluster under load. This code, being an open-source project, is in its early development stage and likely contains various bugs.
 
+Loadbot is a workload driver designed to simulate heavy loads on systems for performance testing and benchmarking purposes. It allows users to generate various types of workloads to stress-test their systems under different scenarios.
 
-## How to use:
-1. Build image - `make build-docker`
-2. Run agent - `make run-docker-agent`
-3. Configure agent by running lbot config command - `make run-docker-lbot-config CONFIG_FILE="_config.json"`
-4. Run workload tests - `make run-docker-lbot start`
+This code, being an open-source project, is in its early development stage and likely contains various bugs. We welcome contributions from the community to help improve loadbot, make it more robust and reliable, and introduce new features.
 
-> Note: If running with local db remember to use host network and configure connection_string to 127.0.0.1 `docker run --network="host" --rm -t mload < config_file.json` or check Makefile
 
-This tool offers two ways to access it: one through CLI arguments and the other via a configuration file. Utilizing the configuration file provides additional functionalities for the tool.
+## How to Install
+
+Using Homebrew (MacOS/Linux)💡
+
+```bash
+brew tap kuzxnia/loadbot
+brew install loadbot
+```
+
+Alternatively, you can install **loadbot** from sources or run it directly in a Docker container. For more information on these installation methods, please refer to the [documentation](https://kuzxnia.github.io/getting_started/install/).
+
+
+## Getting started
+After installing loadbot, you can quickly get started by following these steps:
 
-### CLI usage:
-    A command-line database workload
+1. Run LoadBot agent with your desired configuration using the command:
+```bash
+loadbot start-agent -f config_file.json
+```
 
-    Usage:
-      lbot [command]
+2. Start the workload using the LoadBot client:
+```bash
+loadbot start
+```
 
-    Driver Commands:
-      config      Config
-      start       Start stress test
-      stop        Stop stress test
+3. Monitor the progress of the workload using the command:
+```bash
+loadbot progress
+```
 
-    Additional Commands:
-      completion  Generate the autocompletion script for the specified shell
-      help        Help about any command
+4. To stop the workload, use the following command:
+```bash
+loadbot stop
+```
 
-    Flags:
-      -u, --agent-uri string    loadbot agent uri (default: 127.0.0.1:1234)
-      -h, --help                help for lbot
-      -v, --version             version for lbot
+For more information and detailed instructions, please refer to the [quick start guide](https://kuzxnia.github.io/getting_started/quick-start/).
 
-    Use "lbot [command] --help" for more information about a command.
+
+## Documentation
+For detailed documentation on how to use loadbot and its available features, please refer to the [official documentation](https://kuzxnia.github.io/loadbot/).
+
+
+> Note: If running with local db remember to use host network and configure connection_string to 127.0.0.1 `docker run --network="host" --rm -t mload < config_file.json` or check Makefile
+
+This tool offers two ways to access it: one through CLI arguments and the other via a configuration file. Utilizing the configuration file provides additional functionalities for the tool.
 
 
 Known issue: