From 7387bb3646fd487fc898b1c3c284e06a2e3b16a9 Mon Sep 17 00:00:00 2001
From: Ramses Revengeday <revengeday@noreply.git.cyberwa.re>
Date: Mon, 24 Jun 2024 15:52:31 +0000
Subject: [PATCH] Add README.md

---
 README.md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 85 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6deb8a2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,85 @@
+[![](https://cyberwa.re/dystopika-xml-entries-generator/logo_small.png)](https://cyberwa.re/dystopika-xml-entries-generator/)
+
+# Dystopika XML Entries Generator
+
+A tool for creating XML configurations for Dystopika billboard advertisements in-game. Customize your advertisement settings such as image, excluded aspect ratios, color, grid density, and dot size with our interactive form.
+
+## Table of Contents
+
+- [Project Description](#project-description)
+- [Demo](#demo)
+- [Prerequisites](#prerequisites)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Project Structure](#project-structure)
+- [Contributing](#contributing)
+
+## Project Description
+
+The Dystopika XML Entries Generator is a web-based tool designed to simplify the creation of XML configuration files for Dystopika billboard advertisements in the game. This tool allows users to set various parameters such as the image file, excluded aspect ratios, colors, grid density, and dot size via an intuitive form. Upon submission, it generates a customized XML snippet that can be used directly in the game.
+
+## Demo
+
+Visit [Dystopika XML Entries Generator](https://cyberwa.re/dystopika-xml-entries-generator/) to see the tool in action.
+
+## Prerequisites
+
+Ensure you have the following prerequisites before running the application:
+
+- A modern web browser (Google Chrome, Firefox, Edge, etc.)
+
+## Installation
+
+1. **Clone the repository:**
+
+    ```bash
+    git clone https://git.cyberwa.re/revengeday/dystopika-xml-entries-generator.git
+    ```
+
+2. **Navigate to the project directory:**
+
+    ```bash
+    cd dystopika-xml-entries-generator
+    ```
+
+3. **Open `index.html` in a web browser:**
+
+    You can simply double-click the file or drag and drop it into your preferred browser.
+
+## Usage
+
+1. Enter the required information such as image file, excluded aspect ratios, color, grid density, and dot size in the form.
+2. Click on the **"Generate XML"** button.
+3. The generated XML code will be displayed in the text area below.
+
+## Project Structure
+
+    .
+    ├── bg.jpg
+    ├── favicon.png
+    ├── index.html
+    ├── README.md
+    └── social.jpg
+
+- **`index.html`** - Main HTML file of the application.
+- **`favicon.png`** - Favicon for the application.
+- **`bg.jpg`** - Background image of the application.
+- **`social.jpg`** - Image for social media preview.
+
+## Contributing
+
+Contributions are welcome! To contribute, follow these steps:
+
+1. Fork the repository
+2. Create a new branch (`git checkout -b feature/fooBar`)
+3. Make your changes and commit them (`git commit -am 'Add some fooBar'`)
+4. Push to the branch (`git push origin feature/fooBar`)
+5. Create a new Pull Request
+
+#### Info: git.cyberwa.re Account
+
+If you need a git.cyberwa.re account, please contact [@revengeday@corteximplant.com](https://corteximplant.com/@revengeday).
+
+---
+
+Built with ❤️ by Revengeday
\ No newline at end of file