Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Jake Creps authored Mar 24, 2023
1 parent 1eba35a commit 9324a7b
Showing 1 changed file with 7 additions and 12 deletions.
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,19 @@ Poastal is a powerful email OSINT tool that provides valuable information on any

## :question: How to Use

Go to the 'backend' folder and run `poastal.py` to start a Flask app locally pointing to port 8080.
python
Make sure you have requests installed.

```pip install requests```

Navigate to the backend folder and run `poastal.py` to start the Flask app. This points to port:8080.

```python3 poastal.py```

Open index.html in the root directory to open up the UI.

Enter an email address in the UI and it will request poastal.py and return the information on the page.
Enter an email address in the UI and it will request `poastal.py` and return the information on the page.

## :speech_balloon: Feedback

We hope you find Poastal to be a valuable tool for your OSINT investigations. If you have any feedback or suggestions on how we can improve Poastal, please let us know. We are always looking for ways to improve our tool to better serve our users.

## :clap: Credits

Poastal was developed by our team of experts who are passionate about OSINT investigations. We hope that you find it to be a valuable resource in your investigations.

## :scroll: License

Poastal is free to use and distribute under the MIT License. See the LICENSE file for more information.
I hope you find Poastal to be a valuable tool for your OSINT investigations. If you have any feedback or suggestions on how we can improve Poastal, please let me know. I'm always looking for ways to improve this tool to better serve the OSINT community.

0 comments on commit 9324a7b

Please sign in to comment.