Hiddenden/beef
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #1929 from beefproject/bcoles-patch-1

Browse Source 
Update README.md
This commit is contained in:
jcrew99
2020-05-25 11:07:54 +10:00
committed by GitHub
parent 81cd4e7533 3a713ffd76
commit fe2dd0ac01
1 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -28,7 +28,7 @@ __Bugs:__ https://github.com/beefproject/beef/issues
__Security Bugs:__ security@beefproject.com
__Twitter:__ @beefproject
__Twitter:__ [@beefproject](https://twitter.com/beefproject)
Requirements
@@ -39,13 +39,13 @@ Requirements
* [SQLite](http://sqlite.org): 3.x
* [Node.js](https://nodejs.org): 6 or newer
* The gems listed in the Gemfile: https://github.com/beefproject/beef/blob/master/Gemfile
* Selenium is required on OSX: brew install selenium-server-standalone (See https://github.com/shvets/selenium)
* Selenium is required on OSX: `brew install selenium-server-standalone` (See https://github.com/shvets/selenium)
ActiveRecord
-----------
ActiveRecord was used to replace DataMapper, and now ruby 2.4 is no longer supported.
If you're using ruby 2.4 please update your BeEF version, otherwise master-0.4.7.3 has the beef branch before the ActiveRecord Merge.
ActiveRecord was used to replace DataMapper, and now Ruby 2.4 is no longer supported.
If you're using ruby 2.4 please update your BeEF version, otherwise [beef-0.4.7.3](https://github.com/beefproject/beef/releases/tag/beef-0.4.7.3) has the beef branch before the ActiveRecord Merge.
Quick Start
@@ -59,16 +59,18 @@ The `install` script installs the required operating system packages and all the
$ ./install
```
For full installation details, please refer to [INSTALL.txt](https://github.com/beefproject/beef/blob/master/INSTALL.txt).
For full installation details, please refer to [INSTALL.txt](https://github.com/beefproject/beef/blob/master/INSTALL.txt) or the [Installation](https://github.com/beefproject/beef/wiki/Installation) page on the wiki.
Upon successful installation, be sure to read the [Configuration](https://github.com/beefproject/beef/wiki/Configuration) page on the wiki for important details on configuring and securing BeEF.
Wiki
Documentation
---
We also have an [Installation](https://github.com/beefproject/beef/wiki/Installation) page on the wiki.
Upon successful installation, be sure to read the [Configuration](https://github.com/beefproject/beef/wiki/Configuration)page on the wiki for important details on configuring and securing BeEF.
* [User Guide](https://github.com/beefproject/beef/wiki#user-guide)
* [Frequently Asked Questions](https://github.com/beefproject/beef/wiki/FAQ)
* [JSdocs](https://beefproject.github.io/beef/index.html)
Go to beefproject.github.io/beef/index.html in order to view the JSdocs for BeEF.
Usage
-----