From da72dfe58e50009bf89cce242242cbd670c1d417 Mon Sep 17 00:00:00 2001
From: tek <tek@randhome.io>
Date: Sun, 18 Jul 2021 16:31:25 +0200
Subject: [PATCH] Update readme and version for pypi

---
 README.md | 36 +++++++++++++++++++++++++++++++++++-
 setup.py  |  5 +++--
 2 files changed, 38 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 15e1293..e5f1205 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,42 @@
 
 # Mobile Verification Toolkit
 
-<!-- [![](https://img.shields.io/pypi/v/mvt)](https://pypi.org/project/mvt/) -->
+[![](https://img.shields.io/pypi/v/mvt)](https://pypi.org/project/mvt/)
 
 Mobile Verification Toolkit (MVT) is a collection of utilities to simplify and automate the process of gathering forensic traces helpful to identify a potential compromise of Android and iOS devices.
 
 [Please check out the documentation](https://mvt.readthedocs.io/).
+
+## Installation
+
+First you need to install dependencies, on Linux `sudo apt install python3 python3-pip libusb-1.0-0` or on MacOS `brew install python3 libusb`.
+
+Then you can install mvt from pypi with `pip install mvt`, or directly form sources:
+```bash
+git clone https://github.com/mvt-project/mvt.git
+cd mvt
+pip3 install .
+```
+
+## Usage
+
+MVT provides two commands `mvt-ios` and `mvt-android` with the following subcommands available:
+* `mvt-ios`:
+    * `check-backup`: Extract artifacts from an iTunes backup
+    * `check-fs`: Extract artifacts from a full filesystem dump
+    * `check-iocs`: Compare stored JSON results to provided indicators
+    * `decrypt-backup`:  Decrypt an encrypted iTunes backup
+* `mvt-android`:
+    * `check-adb`: Check an Android device over adb
+    * `check-backup`: Check an Android Backup
+    * `download-apks`: Download all or non-safelisted installed APKs
+
+Check out [the documentation to see how to use them.](https://mvt.readthedocs.io/)
+
+## License
+
+The purpose of MVT is to facilitate the ***consensual forensic analysis*** of devices of those who might be targets of sophisticated mobile spyware attacks, especially members of civil society and marginalized communities. We do not want MVT to enable privacy violations of non-consenting individuals. Therefore, the goal of this license is to prohibit the use of MVT (and any other software licensed the same) for the purpose of *adversarial forensics*.
+
+In order to achieve this, MVT is released under an adaptation of [Mozilla Public License v2.0](https://www.mozilla.org/MPL). This modified license includes a new clause 3.0, "Consensual Use Restriction" which permits the use of the licensed software (and any *"Larger Work"* derived from it) exclusively with the explicit consent of the person/s whose data is being extracted and/or analysed (*"Data Owner"*).
+
+[Read the LICENSE](https://github.com/mvt-project/mvt/blob/main/LICENSE)
diff --git a/setup.py b/setup.py
index d306607..c705fad 100755
--- a/setup.py
+++ b/setup.py
@@ -7,7 +7,7 @@ import os
 from setuptools import setup, find_packages
 
 __package_name__ = "mvt"
-__version__ = "1.0"
+__version__ = "1.0.11"
 __description__ = "Mobile Verification Toolkit"
 
 this_directory = os.path.abspath(os.path.dirname(__file__))
@@ -47,7 +47,8 @@ setup(
     version=__version__,
     description=__description__,
     long_description=long_description,
-
+    long_description_content_type="text/markdown",
+    url="https://github.com/mvt-project/mvt",
     entry_points={
         "console_scripts": [
             "mvt-ios = mvt.ios:cli",