diff --git a/README.md b/README.md index 7678db5..165a72e 100644 --- a/README.md +++ b/README.md @@ -29,28 +29,46 @@ Currently supported more than 2000 sites ([full list](./sites.md)), by default s ## Installation -You can run Maigret in the cloud or install it on your machine. - -[![Open in Cloud Shell](https://user-images.githubusercontent.com/27065646/92304704-8d146d80-ef80-11ea-8c29-0deaabb1c702.png)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/soxoj/maigret&tutorial=README.md) [![Run on Repl.it](https://user-images.githubusercontent.com/27065646/92304596-bf719b00-ef7f-11ea-987f-2c1f3c323088.png)](https://repl.it/github/soxoj/maigret) - **NOTE**: Python 3.6 or higher and pip is required. **Python 3.8 is recommended.** +### Package installing ```bash # install from pypi -$ pip3 install maigret +pip3 install maigret # or clone and install manually -$ git clone https://github.com/soxoj/maigret && cd maigret -$ pip3 install . +git clone https://github.com/soxoj/maigret && cd maigret +pip3 install . +``` + +### Cloning a repository + +```bash +git clone https://github.com/soxoj/maigret && cd maigret +``` + +You can use your a free virtual machine, the repo will be automatically cloned: + +[![Open in Cloud Shell](https://user-images.githubusercontent.com/27065646/92304704-8d146d80-ef80-11ea-8c29-0deaabb1c702.png)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/soxoj/maigret&tutorial=README.md) [![Run on Repl.it](https://user-images.githubusercontent.com/27065646/92304596-bf719b00-ef7f-11ea-987f-2c1f3c323088.png)](https://repl.it/github/soxoj/maigret) + +```bash +pip3 install -r requirements.txt ``` ## Using examples ```bash -maigret user +# for a cloned repo +./maigret.py user +# for a package +maigret user +``` + +Features: +```bash # make HTML and PDF reports maigret user --html --pdf