Skip to content
This repository was archived by the owner on Oct 22, 2020. It is now read-only.

Commit d303ff2

Browse files
committed
Update readme and contributing with information for v2
1 parent eac1f0a commit d303ff2

File tree

2 files changed

+18
-14
lines changed

2 files changed

+18
-14
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
# How to contribute
22
Contributions are always welcome, however, to keep things consistent, please review the following guidelines.
33

4+
## Setting up your environment
5+
Ensure that you have Ruby >= 2.4.4 installed on your system and then install all required dependencies by opening a command prompt / terminal in the WPXF folder and running ```bundle install```.
6+
7+
If bundler is not present on your system, you can install it by running ```gem install bundler```.
8+
49
## Update unit tests
5-
If you change a core piece of functionality (i.e. in ```lib/wpxf/*```) then ensure the corresponding unit tests in the ```spec``` folder are updated.
10+
If you change a core piece of functionality (i.e. in ```lib/*```) then ensure the corresponding unit tests in the ```spec``` folder are updated.
611

712
For more information on writing unit tests with RSpec, see https://relishapp.com/rspec
813

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,13 @@
22

33
<h1 align="center">WordPress Exploit Framework</h1>
44
<p align="center">
5-
<a href="https://travis-ci.org/rastating/wordpress-exploit-framework">
6-
<img src="https://travis-ci.org/rastating/wordpress-exploit-framework.svg?branch=v2" alt="Build Status" />
7-
</a>
5+
<a href="https://travis-ci.org/rastating/wordpress-exploit-framework"><img src="https://travis-ci.org/rastating/wordpress-exploit-framework.svg?branch=v2" alt="Build Status" height="20" /></a>
86

9-
<a href="https://codeclimate.com/github/rastating/wordpress-exploit-framework/maintainability">
10-
<img src="https://api.codeclimate.com/v1/badges/5414ccc4e7a1f5e38c79/maintainability" alt="Maintainability" />
11-
</a>
7+
<a href="https://codeclimate.com/github/rastating/wordpress-exploit-framework/maintainability"><img src="https://api.codeclimate.com/v1/badges/5414ccc4e7a1f5e38c79/maintainability" alt="Maintainability" height="20" /></a>
128

13-
<a href="https://coveralls.io/github/rastating/wordpress-exploit-framework?branch=v2">
14-
<img src="https://coveralls.io/repos/github/rastating/wordpress-exploit-framework/badge.svg?branch=v2" alt="Coverage Status" />
15-
</a>
9+
<a href="https://coveralls.io/github/rastating/wordpress-exploit-framework?branch=v2"><img src="https://coveralls.io/repos/github/rastating/wordpress-exploit-framework/badge.svg?branch=v2" alt="Coverage Status" height="20" /></a>
10+
11+
<a href="https://badge.fury.io/rb/wpxf"><img src="https://badge.fury.io/rb/wpxf@2x.png" alt="Gem Version" height="20"></a>
1612
</p>
1713

1814
<p align="center">
@@ -26,10 +22,13 @@ This branch is for the development of the next major release. It will contain co
2622

2723
Do not use this branch unless you are prepared to encounter bugs.
2824

29-
### What do I need to run it?
30-
Ensure that you have Ruby >= 2.4.4 installed on your system and then install all required dependencies by opening a command prompt / terminal in the WPXF folder and running ```bundle install```.
25+
### Installation
26+
To install the latest build of the v2 branch, run `gem install wpxf --pre`.
3127

32-
If bundler is not present on your system, you can install it by running ```gem install bundler```.
28+
After installation, you can launch the WordPress Exploit Framework console by running `wpxf`.
29+
30+
### What do I need to run it?
31+
Ruby >= 2.4.4 is required to run WordPress Exploit Framework.
3332

3433
### Troubleshooting Installation
3534
#### Debian Systems
@@ -51,7 +50,7 @@ If you are experiencing errors that indicate that ```libcurl.dll``` could not be
5150
The latest version can be downloaded from http://curl.haxx.se/download.html. As of 16/05/2016, the latest release is marked as ```Win32 2000/XP zip 7.40.0 libcurl SSL```. After downloading the archive, extract the contents of the bin directory into your Ruby bin directory (if prompted, don't overwrite any existing DLLs).
5251

5352
### How do I use it?
54-
Open a command prompt / terminal in the directory that you have downloaded WordPress Exploit Framework to, and start it by running ```ruby wpxf.rb```.
53+
Start the WordPress Exploit Framework console by running `wpxf`.
5554

5655
Once loaded, you'll be presented with the wpxf prompt, from here you can search for modules using the ```search``` command or load a module using the ```use``` command.
5756

0 commit comments

Comments
 (0)