fixing readme

Author: teo-nikolov

README.md

@@ -1,108 +1,113 @@
 # BELLATRIX-JavaScript
-BELLATRIX Tailor-made Test Automation Framework
+
+## BELLATRIX Tailor-made Test Automation Framework
 
 Customize and extend our cross-platform framework to perfectly fit your needs. Start on top of hundreds of best practice features and integrations.
 
 Contains the full source code of BELLATRIX Test Automation Framework and Templates for faster usage
 
 BELLATRIX is not a single thing it contains multiple framework libraries, extensions and tools. The tool is built to be cross-platform, however some of the features can be used under Windows since they are written for Visual Studio.
 
-Simple Installation
+## Simple Installation
 
 - Download the BELLATRIX projects as a zip file from the Code green button in the right corner.
--Unzip it. Open BELLATRIX-JavaScript in Visual Studio Code.
-- Open terminal and type npm ci in the root of the project.    
+- Unzip it. Open BELLATRIX-JavaScript in Visual Studio Code.
+- Open terminal and type npm ci in the root of the project.
 - In order to run the sample tests, navigate to the example folder with terminal and type npm run test.
-- You can try to write a simple test yourself.    
+- You can try to write a simple test yourself.
 - For an in-depth revision of all framework features you can check the official documentation
 
-Running Tests through CLI
+## Running Tests through CLI
 
 To execute your tests via command line in Continues Integration (CI), you can use the Bellatrix CLI through an npm script.
 
 - Navigate to the folder of your test project.
 - Open the CMD there.
 - Execute the following command:
 
-      bellatrix <path>
+`bellatrix <path>`
 
 where path is an optional argument for a path to the tests folder, either relative or absolute.
 
 Filters and other more advanced configurations will be supported in a future version.
 
 Our project uses Semantic Versioning (SemVer) for clear and predictable version management. Each release is tagged with a unique version number that reflects the nature of the changes made.
-Tags and Releases
 
-    Tags: We create Git tags for each release to mark specific points in the project's history, making it easier for users to switch between versions.
-    Release Notes: Detailed notes accompany each release, highlighting new features, bug fixes, and any breaking changes.
+## Tags and Releases
+
+Tags: We create Git tags for each release to mark specific points in the project's history, making it easier for users to switch between versions.
+Release Notes: Detailed notes accompany each release, highlighting new features, bug fixes, and any breaking changes.
 
-Accessing Releases
+## Accessing Releases
 
 Users can access the specific releases directly from our GitHub repository's Releases page or BELLATRIX website's roadmap section. Each release includes a tag, a summary of changes, and assets (if applicable).
 Integrating BELLATRIX as a Submodule in Your Project
 Adding BELLATRIX as a Submodule
 
 To leverage a specific version of BELLATRIX in your project, you can add it as a Git submodule. This allows you to keep your copy of BELLATRIX up to date or locked to a specific version, depending on your project's needs.
 
-    Navigate to Your Project Directory: Open a terminal and change to the directory where your project is located.
-    Add BELLATRIX as a Submodule: Use the following Git command to add BELLATRIX as a submodule to your project:
+Navigate to Your Project Directory: Open a terminal and change to the directory where your project is located.
+Add BELLATRIX as a Submodule: Use the following Git command to add BELLATRIX as a submodule to your project:
 
-git submodule add https://github.com/BELLATRIX-Library/BELLATRIX.git path/to/submodule
+`git submodule add https://github.com/BELLATRIX-Library/BELLATRIX.git path/to/submodule`
 
 Replace path/to/submodule with the relative path within your project where you'd like the BELLATRIX submodule to reside. Initialize and Clone the Submodule: If you're adding the submodule for the first time, initialize your local configuration file and clone the BELLATRIX repository as follows:
 
-git submodule update --init --recursive
+`git submodule update --init --recursive`
 
 Checking Out a Specific Tag (Release Version)
 
 After adding BELLATRIX as a submodule, you might want to use a specific release version rather than the latest commit on the main branch.
 
-    Navigate to the Submodule Directory: Change into the BELLATRIX submodule directory within your project:
+Navigate to the Submodule Directory: Change into the BELLATRIX submodule directory within your project:
 
-cd path/to/submodule
+`cd path/to/submodule`
 
-    Fetch All Tags from the BELLATRIX Repository: To ensure you have a list of all available tags, fetch them:
+Fetch All Tags from the BELLATRIX Repository: To ensure you have a list of all available tags, fetch them:
 
-git fetch --tags
+`git fetch --tags`
 
-    Checkout the Desired Tag: Check out the specific tag (release version) you want to use by replacing <tagname> with the desired version:
+Checkout the Desired Tag: Check out the specific tag (release version) you want to use by replacing <tagname> with the desired version:
 
-git checkout tags/<tagname>` 
+`git checkout tags/<tagname>`
 
 For example, if you want to check out version v3.9.0.0, you would use: git checkout tags/v3.9.0.0
 
-    Commit the Submodule Change: Navigate back to your project's root directory, and commit the change to the submodule reference:
+Commit the Submodule Change: Navigate back to your project's root directory, and commit the change to the submodule reference:
 
-cd ../..
-git add path/to/submodule
-git commit -m "Update BELLATRIX submodule to v3.9.0.0"
+`cd ../..`
+`git add path/to/submodule`
+`git commit -m "Update BELLATRIX submodule to v3.9.0.0"`
 
 This process ensures that your project uses a specific, fixed version of BELLATRIX, providing stability and consistency across environments or deployments.
 Contributing to Our Project
 
 We welcome contributions from the community, whether it's in the form of bug reports, feature requests, documentation improvements, or code contributions.
-Getting Started
 
-    Fork the Repository: Start by forking the repository to your GitHub account. This provides you with a personal workspace for making changes.
-    Clone Your Fork: Clone your fork to your local machine to start working on the changes.
+## Getting Started
+
+Fork the Repository: Start by forking the repository to your GitHub account. This provides you with a personal workspace for making changes.
+Clone Your Fork: Clone your fork to your local machine to start working on the changes.
 
-Making Changes
+## Making Changes
 
-    Create a Feature Branch: From your fork, create a new branch for your work. This keeps your changes organized and separate from the main branch.
-    Commit Your Changes: Make your changes locally, and commit them to your feature branch. Use clear and descriptive commit messages.
+Create a Feature Branch: From your fork, create a new branch for your work. This keeps your changes organized and separate from the main branch.
+Commit Your Changes: Make your changes locally, and commit them to your feature branch. Use clear and descriptive commit messages.
 
-Submitting Contributions
+## Submitting Contributions
 
-    Pull from Upstream: Before submitting your contribution, pull the latest changes from the upstream main branch into your feature branch to minimize merge conflicts.
-    Push to Your Fork: Push your changes to your fork on GitHub.
-    Open a Pull Request (PR): Submit a pull request from your feature branch to the main branch of the original repository. Provide a clear description of your changes and any relevant issue numbers.
+Pull from Upstream: Before submitting your contribution, pull the latest changes from the upstream main branch into your feature branch to minimize merge conflicts.
+Push to Your Fork: Push your changes to your fork on GitHub.
+Open a Pull Request (PR): Submit a pull request from your feature branch to the main branch of the original repository. Provide a clear description of your changes and any relevant issue numbers.
 
-Code Review
+## Code Review
 
 Review Process: Your PR will be reviewed by the project maintainers. They may provide feedback or request changes. Be open to discussion and willing to make adjustments as needed.
-After Your PR is Merged
+
+## After Your PR is Merged
 
 Once your PR is merged, your contributions will become part of the project. You can then safely delete your feature branch.
-Supported Code Editors
+
+## Supported Code Editors
 
 The recommended code editor for writing BELLATRIX tests is Visual Studio Code