Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bcoles committed Feb 10, 2019
1 parent f48acc3 commit c4a324c
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
6 changes: 3 additions & 3 deletions INSTALL.txt
Expand Up @@ -21,9 +21,9 @@ Or cloning the Git repository from Github:
Prerequisites
--------------

BeEF requires Ruby 2.3+.
BeEF requires Ruby 2.4+.

If your operating system package manager does not support Ruby version 2.3,
If your operating system package manager does not support Ruby version 2.4,
you can add the brightbox ppa repository for the latest version of Ruby:

$ sudo apt-add-repository -y ppa:brightbox/ruby-ng
Expand All @@ -32,7 +32,7 @@ Alternatively, consider using a Ruby environment manager such as rbenv or rvm
to manager your Ruby versions. Refer to the following for more information:

* rbenv: https://github.com/rbenv/rbenv
* rvm: https://rvm.io/rvm/install'
* rvm: https://rvm.io/rvm/install


Installation
Expand Down
15 changes: 10 additions & 5 deletions README.md
Expand Up @@ -36,12 +36,13 @@ __Twitter:__ @beefproject
Requirements
------------

* Operating System: Mac OSX 10.5.0 or higher / modern Linux
* [Ruby](http://ruby-lang.org): 2.3 or newer
* Operating System: Mac OSX 10.5.0 or higher / modern Linux. Note: Windows is not supported.
* [Ruby](http://ruby-lang.org): 2.4 or newer
* [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
* 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)


Quick Start
-----------
Expand All @@ -50,7 +51,9 @@ __The following is for the impatient.__

The `install` script installs the required operating system packages and all the prerequisite Ruby gems:

$ ./install
```
$ ./install
```

For full installation details, please refer to [INSTALL.txt](https://github.com/beefproject/beef/blob/master/INSTALL.txt).

Expand All @@ -64,4 +67,6 @@ Usage

To get started, simply execute beef and follow the instructions:

$ ./beef
```
$ ./beef
```

0 comments on commit c4a324c

Please sign in to comment.