From c9481f5a2eab1032d4f548085649f89af260d428 Mon Sep 17 00:00:00 2001 From: Shadow Nox <43514781+ShadowNoxX@users.noreply.github.com> Date: Sat, 11 Sep 2021 17:21:34 +0200 Subject: [PATCH] Update README.md --- README.md | 48 +++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 41 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 105dec4..bda082c 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,46 @@

An Omegle bot built on top of Selenium.

- + + + +

-# Installation -1. Add your geckodriver to path -2. Create messages.txt and put your messages separated with a newline -3. Compile and run -# Build Jar -`gradlew jar` +## Features +* Automatic Skip + - Skips when user leaves. + - Skips when all messages are sent. +* Custom messages + - Write your own messages in messages.txt. +* Headless + - Choose wether or not Lux should be visible. +* Fast + - Lux is optimized for speed. +* Cross Platform + - Windows, macOS and Linux. + +## How to use +To clone and run this application, you'll need [Git](https://git-scm.com), [Firefox](https://www.mozilla.org/en-US/firefox/new/), [Geckodriver to PATH](https://github.com/mozilla/geckodriver/releases) and [IntelliJ IDEA](https://www.jetbrains.com/idea/) (which comes with [Kotlin](https://kotlinlang.org/) and [Gradle](https://gradle.org/) support) installed on your computer. From your command line: + +```bash +# Clone this repository +$ git clone https://github.com/ShadowNoxX/Lux.git + +# Open it inside IntelliJ Idea + +# Sync Gradle + +# Run + +# If you want to generate a jar file +$ gradlew jar +``` + +## Download +You can [download](https://github.com/ShadowNoxX/Lux/releases/) the latest installable version of Lux for Windows, macOS and Linux. + +## Credits +This software uses the following open source packages: +- [Kotlin](https://github.com/JetBrains/kotlin) +- [Selenium](https://www.selenium.dev/)