From 51babb3c454de4d1a9ce598ef511efec334176db Mon Sep 17 00:00:00 2001 From: Richard Mwewa <74001397+rly0nheart@users.noreply.github.com> Date: Wed, 27 Apr 2022 17:09:33 +0200 Subject: [PATCH] Update README.md --- README.md | 87 +++++++++---------------------------------------------- 1 file changed, 14 insertions(+), 73 deletions(-) diff --git a/README.md b/README.md index 075ec7b..b68282d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +![octosuite](https://user-images.githubusercontent.com/74001397/165550323-d880e320-a4c0-4f4e-87dd-d2e8319554ec.png) + ![OS](https://img.shields.io/badge/OS-GNU%2FLinux-red?style=for-the-badge&logo=Linux) ![OS](https://img.shields.io/badge/OS-Windows-blue?style=for-the-badge&logo=Windows) ![OS](https://img.shields.io/badge/OS-Mac-white?style=for-the-badge&logo=apple) @@ -9,6 +11,12 @@ > *Simply gather OSINT on Github users & organizations like a GodπŸ”₯* +# INSTALLATION +Installation instructions are on the wiki, in addition to all other documentation. + +[Refer to the Wiki](https://github.com/rly0nheart/octosuite/wiki) + +*** # FEATURES - [x] Fetches organization info - [x] Fetches user info @@ -28,77 +36,7 @@ - [x] Automatically logs network activity (.logs folder) - [x] User can view, read and delete log files -# INSTALLATION -## Clone from Github - -``` -git clone https://github.com/rly0nheart/octosuite.git -``` -![Screenshot_20220414-002508](https://user-images.githubusercontent.com/74001397/163280996-ed0f8817-c3e3-49d8-9e15-93452cb08a3e.jpg) - - -``` -cd octosuite -``` -![Screenshot_20220414-002214](https://user-images.githubusercontent.com/74001397/163281317-158bbf7b-073f-457e-8a8a-730d4c0ed413.jpg) - - -``` -pip install -r requirements.txt -``` -![Screenshot_20220414-004420](https://user-images.githubusercontent.com/74001397/163282481-6cb5efe8-6e5a-4c2b-a8b5-7ff99f7ca293.jpg) - - - -## Install from PyPI -``` -pip install octosuite -``` -![Screenshot_20220414-005400](https://user-images.githubusercontent.com/74001397/163283184-e9458439-8074-4338-938b-4588390bb6b7.jpg) - - -# GITHUB FORK USAGE -## Linux -``` -sudo chmod +x octosuite -``` -![Screenshot_20220414-004443](https://user-images.githubusercontent.com/74001397/163282620-a5307969-bcce-49d1-ad3c-c3ea0f78fb44.jpg) - - -``` -sudo ./octosuite -``` -![Screenshot_20220414-004507](https://user-images.githubusercontent.com/74001397/163282716-41ace7fc-ee04-4c95-985e-68dd3286682c.jpg) - - - - -## Windows -``` -python3 octosuite -``` - -## Mac -``` -python3 octosuite -``` - -# PYPI PACKAGE USAGE -## Linux -``` -octosuite -``` - -## Windows -``` -octosuite -``` - -## Mac -``` -octosuite -``` - +*** # AVAILABLE COMMANDS | COMMAND | DESCRIPTION| | ------------- |:---------:| @@ -125,19 +63,22 @@ octosuite | ``help`` | *show usage/help* | | ``exit`` | *exit session* | - -# NOTE +*** +# NOTES * *octosuite automatically logs network and minor user activity. The logs are saved by date and time in .logs folder* * *Although octosuite was developed to work on **Mac**, **Windows**, or any **Linux** *Distribution*, it has only been tested on **Termux** *and* **Kali Linux*** * *If you believe octosuite can be better, feel free to open a pull request with your improvements* βœŒπŸΎπŸ™‚ +*** # PYPI [PyPI Package](https://pypi.org/project/octosuite) ![PyPI Downloads](https://pepy.tech/badge/octosuite) +*** # LICENSE ![license](https://user-images.githubusercontent.com/74001397/137917929-2f2cdb0c-4d1d-4e4b-9f0d-e01589e027b5.png) +*** # ABOUT DEVELOPER [About.me](https://about.me/rly0nheart)