mirror of
https://github.com/soxoj/maigret.git
synced 2026-05-06 22:19:01 +00:00
Update README.md
This commit is contained in:
@@ -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.
|
||||
|
||||
[](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/soxoj/maigret&tutorial=README.md) [](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:
|
||||
|
||||
[](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/soxoj/maigret&tutorial=README.md) [](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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user