diff --git a/README.md b/README.md
index 585d766..8d1c8f8 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,19 @@
# RediSea
-
+
RediSea is a Redis (in-memory database) communication framework used for viewing Redis keys, dumping Redis keys, dumping key information about the Redis server, and much more!
+Please note, this framework does work even if a Redis instance is not present, but if running a command that requires direct communication with the database (ex: viewing a key), you will be removed from the prompt. There is also an option for remotely connecting to a Redis instance, if you prefer to not have the framework on the target system.
+
+## Installation
+You can run this command to install all the required tools for this framework:
+```bash
+$ pip3 install -r requirements.txt
+```
+
## Usage
```bash
-python3 main.py
+$ cd redisea
+$ python3 main.py
```
\ No newline at end of file
diff --git a/assets/redis.png b/assets/redis.png
deleted file mode 100644
index b17e633..0000000
Binary files a/assets/redis.png and /dev/null differ
diff --git a/assets/redisea_bannerv2.png b/assets/redisea_bannerv2.png
new file mode 100644
index 0000000..66d77c8
Binary files /dev/null and b/assets/redisea_bannerv2.png differ
diff --git a/main.py b/redisea/main.py
similarity index 92%
rename from main.py
rename to redisea/main.py
index 88416bf..1b562d8 100644
--- a/main.py
+++ b/redisea/main.py
@@ -1,11 +1,10 @@
# -*- coding: utf-8 -*-
-import redis, time, sys, os
-
+import redis, time, sys, os, platform
from subprocess import getoutput
r = redis.Redis()
-version = '0.1.26'
+version = '0.1.28'
author = 'Hifumi1337'
class RediSea:
@@ -21,7 +20,7 @@ def banner(self):
{0} | v{1}
- Traverse the Redis-cli in a much simpler way by using our open prompt!
+Traverse a Redis database instance in a much simpler way by using our open prompt!
Start by typing "h" in the prompt below
@@ -29,8 +28,6 @@ def banner(self):
def redis_comms(self):
- rsb = RediSea()
-
whoami = getoutput("whoami")
print("Connecting...")
@@ -64,7 +61,12 @@ def redis_comms(self):
print(f"Key: {key} \n Value: {key_output}")
elif command == "c" or command == "clear":
- os.system("clear")
+ system_info = platform.system()
+
+ if system_info == 'Windows':
+ os.system("cls")
+ else:
+ os.system("clear")
elif command == "dump" or command == "d":
for key in r.scan_iter("*"):
print(key)
@@ -75,7 +77,7 @@ def redis_comms(self):
print("Data successfully dumped!")
elif command == "b" or command == "banner":
- rsb.banner()
+ RediSea().banner()
elif command == "i" or command == "info":
redis_data = r.execute_command('CLIENT LIST')
redis_data_str = str(redis_data)