From c4a324c80f08a8db84581b259a1e36aec92a7ed7 Mon Sep 17 00:00:00 2001 From: Brendan Coles Date: Sun, 10 Feb 2019 10:53:03 +0000 Subject: [PATCH] Update documentation --- INSTALL.txt | 6 +++--- README.md | 15 ++++++++++----- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/INSTALL.txt b/INSTALL.txt index 8664d2653..5fec4026d 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -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 @@ -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 diff --git a/README.md b/README.md index 9709e0cf8..7bb5370db 100644 --- a/README.md +++ b/README.md @@ -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 ----------- @@ -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). @@ -64,4 +67,6 @@ Usage To get started, simply execute beef and follow the instructions: - $ ./beef +``` +$ ./beef +```