diff --git a/README.md b/README.md index d394259..178abf6 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,22 @@ $ git clone https://github.com/rly0nheart/octosuite.git $ cd octosuite ``` +# Usage ``` $ python octosuite ``` -> Enter *help* command to show usage +# Note +* Requirement(s) [requests] will be install on first run +* Enter *help* command to show usage +* octosuite automatically logs network and minor user activity. The logs are saved by date and time in .logs folder + +* octosuite has been tested on *Linux* only, and it might probably not work as intended on *Windows* or *Mac* (especially) + +* Feel free to open a pull requests if there are any notable bugs found + +# LICENSE +![license](https://user-images.githubusercontent.com/74001397/137917929-2f2cdb0c-4d1d-4e4b-9f0d-e01589e027b5.png) + +# About me +* [About.me](https://about.me/rly0nheart)