Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
6abd authored Apr 15, 2024
1 parent 2fb4166 commit 48f7acb
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,33 @@

Horus is an all-in-one encompassing tool for investigations assistance, from API leveraging to compiling data too. Its your pre-ops buddy!

## Installation and Usage Instructions
To get started with this project, follow these steps:

1. Clone this repository.
2. Move to the 'horus' directory.
3. Install dependencies using the following command: ```pip install -r requirements. txt```
4. In the 'sentinel' directory, run ```python3 horus.py```

## API Configuration
To configure the APIs necessary for usage of certain commands, you can either manually enter them, or use the 'apicon' command

To manually configure API keys, navigate to ```/src/modules/var/pipes/api_config.json```. Enter your API keys in their corresponding entries.

## 🤝 Current Contributors

- [Maestro](https://github.com/digitalized-snake) (Me) | Project Lead and Developer

## Contributing
- If you notice a bug or want to request a feature, make an issue with the appropriate tag
- If you would like to fix a bug or add a feature yourself, make a PR and I'll take a look
- If you would like to become a long-term maintainer/contributor, contact me
- For any other inquiries, you may also contact me

Contact info:
- Email: digitalizedsnake@gmail.com
- Discord: maestro.hq or through the [community server](https://discord.gg/PhkqXAT7Ax)

## Intended Features
```
🟢 = Fully implemented or more than 80% done
Expand All @@ -35,3 +56,5 @@ Horus is an all-in-one encompassing tool for investigations assistance, from API
- [Mart](https://github.com/marvhus) | Was Previously Sr Dev
- [Maestro](https://github.com/digitalized-snake) (Me) | Was Previously Jr Dev
- [Mu](https://github.com/IamMU) | Was Previously Jr Dev

*Some code used can be attributed to [Fox](https://github.com/FoxIDK) and [Askerdyne Ltd.](https://askerdyne.com/), specifically the 'Loki' encryption toolset.*

0 comments on commit 48f7acb

Please sign in to comment.