Skip to content

Commit

Permalink
readme typo
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronsdevera committed Jul 27, 2022
1 parent f602b45 commit 0ed413b
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
# vxdb

## [Installation ⚙️](#getting-started) | [Docs 📚](https://mwdblib.readthedocs.io/en/latest/) | [Guide 📕](https://mwdb.readthedocs.io/en/latest/user-guide/8-REST-and-mwdblib.html)

---

API bindings for [virus.exchange](https://virus.exchange), which is [VX Underground](https://www.vx-underground.org/)'s malware repository based on [mwdb.cert.pl](https://mwdb.cert.pl).

Latest version requires Python >= 3.7.

## Getting started
## Installation

```console
$ pip install vxdb
Expand All @@ -19,6 +15,16 @@ $ pip install vxdb[cli]
$ vxdb version
```

Further help with Installation can be found on MWDB:

* [MWDB Installation](#getting-started)
* [MWDB Docs](https://mwdblib.readthedocs.io/en/latest/)
* [MWDB Guide](https://mwdb.readthedocs.io/en/latest/user-guide/8-REST-and-mwdblib.html)

---

## Getting started

The main interface is the VXDB object that provides various methods to interact with virus.exchange.

```python
Expand All @@ -43,7 +49,7 @@ Password:
```console
$ vxdb --help

Usage: mwdb [OPTIONS] COMMAND [ARGS]...
Usage: vxdb [OPTIONS] COMMAND [ARGS]...

VXDB Core API client

Expand Down

0 comments on commit 0ed413b

Please sign in to comment.