Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
danner26 authored Apr 10, 2019
1 parent 3944415 commit 0238242
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,11 @@
# bunny-api
BashBunny API
# BunnyAPI

`BunnyAPI` is a Node.JS/Express.JS simple API that retrieves JSON from the [BunnyScripts](https://github.com/danner26/BunnyScripts) repo by Daniel W. Anner and Gregory Walsh. This project is originally for our CSIS33-3381 with Dr. Aakash Taneja. In working on this project, we have found a new respect and passion for these Bash Bunny scripts. We plan to keep our research going, and continue to upkeep as well as integrate new features for this API.

## Usage
When using this API, you are free to adapt it for your needs, but it will work best with the tested scripts over in the [BunnyScripts](https://github.com/danner26/BunnyScripts) repo. After following the [wiki setup](https://github.com/danner26/BunnyAPI/wiki/Setup-Install-Guide), you are set to use the API!

### Current API locations
| BunnyScript | API Base (Port+Path) | Individual API Path | Full API Path |
| ----------------- | -------------------- | ------------------- | -------------------------------------------------- |
| ChromeCreds | 4001 + /chrome | /submitChromeCreds | http(s)://domain.tld:4001/chrome/submitChromeCreds |

0 comments on commit 0238242

Please sign in to comment.