diff --git a/README.md b/README.md index 7f7bab6..e6d631d 100644 --- a/README.md +++ b/README.md @@ -1 +1,40 @@ -# ghostforge \ No newline at end of file +
+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.
+ +[Usage](#usage) • +[Installation](#installation) • +[Contributing](#contributing) • +[License](#license) +
+ +## 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. \ No newline at end of file diff --git a/doc/ghostforge.png b/doc/ghostforge.png new file mode 100644 index 0000000..7b43ee9 Binary files /dev/null and b/doc/ghostforge.png differ