Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alvarodh5 authored Feb 12, 2019
1 parent 0408520 commit 9a6f543
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
# WhiteBox Audit Extension
<p align="center">
<a href="https://red4sec.com" target="_blank"><img src="https://red4sec.com/images/logo.png" width="200px"></a>
</p>
<h1 align="center">
WhiteBox Audit Extension
</h1>

Whitebox Audit is an extension for visual code that will help you in your white box audit tasks.
<p align="center">
Whitebox Audit is an extension for visual code that will help you in your white box audit tasks.
</p>

## Table of Contents

- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Compilation](#compilation)
- [Debuging](#debuging)
- [Changelog](#changelog)

## Features
Expand All @@ -20,12 +28,14 @@ This extension will allow you to keep track of both the audited files and the is
![OK](https://i.imgur.com/sHpdlc7.png)

## Requirements
No requirements needed

Make sure you have Node.js installed.
## Compilation
Make sure you have Node.js installed. (Only for devs)

## Installation
## Debuging

In this version (1.0.0) you must debug the extension to use it.
In this version (0.0.1) you must debug the extension to use it.

* Press `F5` to open a new window with your extension loaded.
* Run your command from the command palette by pressing (`Ctrl+Shift+P` or `Cmd+Shift+P` on Mac) and typing `WhiteBoxAudit`.
Expand All @@ -34,6 +44,6 @@ In this version (1.0.0) you must debug the extension to use it.

## Changelog

### 1.0.0
### 0.0.1

Initial release of WhiteBoxAudit Extension

0 comments on commit 9a6f543

Please sign in to comment.