mirror of
https://github.com/DarrylNixon/ghostforge
synced 2024-04-22 06:27:20 -07:00
readme
This commit is contained in:
parent
2d4b5b0748
commit
25ca052ec1
2 changed files with 40 additions and 1 deletions
39
README.md
39
README.md
|
@ -1 +1,40 @@
|
|||
<div align="center">
|
||||
<img src="doc/ghostforge.png" alt="ghostforge Logo">
|
||||
|
||||
# ghostforge
|
||||
|
||||
ghostforge manages **false identity information** for privacy prudent users.
|
||||
|
||||
tl;dr it's a fancy DB frontend with sensible design, tailored features, and a nice UX.<br/>
|
||||
|
||||
[Usage](#usage) •
|
||||
[Installation](#installation) •
|
||||
[Contributing](#contributing) •
|
||||
[License](#license)
|
||||
</div>
|
||||
|
||||
## Usage
|
||||
|
||||
To use the tool, run the following command:
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
To use this tool, you need Python 3 installed. Install it with something like:
|
||||
|
||||
```
|
||||
git clone https://github.com/darrylnixon/cf_deny.git
|
||||
cd binhop
|
||||
pip install -r requirements.txt
|
||||
pip install .
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
If you would like to contribute to this project, feel free to submit a pull request or open an issue on GitHub.
|
||||
|
||||
This tool was written as part of my coursework for CSC 842 - Security Tool Development at Dakota State University. Consequently, I may choose not to maintain this tool beyond the length of the course, but have selected a license that enables open contributions in any case.
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the GPLv3 License, because it's important to give back. See the `LICENSE` file for details.
|
BIN
doc/ghostforge.png
Normal file
BIN
doc/ghostforge.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 34 KiB |
Loading…
Reference in a new issue