Skip to content

Commit 4fe1a8c

Browse files
authored
Update README.md
1 parent b9535c9 commit 4fe1a8c

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,38 @@ It can also ruin your day by letting you know how much your code sucks.
1212

1313
So like... enjoy.
1414

15-
## Deps
15+
## Deps 📦
1616

1717
It uses a bundle of different linters and a code formatter:
1818

19-
[bandit](https://bandit.readthedocs.io/) | [black](https://github.com/psf/black) | [codespell](https://github.com/codespell-project/codespell) | [mypy](https://mypy.readthedocs.io/) | [pylama](https://github.com/klen/pylama) | [pylint](https://github.com/pylint-dev/pylint) | [pyright](https://github.com/microsoft/pyright) | [ruff](https://github.com/astral-sh/ruff)
19+
[bandit](https://bandit.readthedocs.io/)
20+
| [black](https://github.com/psf/black)
21+
| [codespell](https://github.com/codespell-project/codespell)
22+
| [mypy](https://mypy.readthedocs.io/)
23+
| [pylama](https://github.com/klen/pylama)
24+
| [pylint](https://github.com/pylint-dev/pylint)
25+
| [pyright](https://github.com/microsoft/pyright)
26+
| [ruff](https://github.com/astral-sh/ruff)
2027

21-
## Installation
28+
## Installation 💾
2229

23-
Just put it where your project is and install required modules:
30+
Just put it where your project is and install the required modules:
31+
32+
```
33+
./okrutnik.sh --install
34+
```
35+
36+
Include custom modules used in your project with `-r requirements.txt`:
2437

2538
```
2639
./okrutnik.sh --install -r requirements.txt
2740
```
2841

29-
Okrutnik will create venv in .okrutnik_venv for itself and store its tools in ordor to perform a scan.
42+
Okrutnik will create a virtual Python environment in .okrutnik_venv for itself and store its tools in order to perform a scan.
3043

3144
You can --update or --uninstall them at any time.
3245

33-
## Usage
46+
## Usage 🚀
3447

3548
```
3649
./okrutnik.sh target.py
@@ -57,14 +70,14 @@ Standalone:
5770
--safety Run safety check
5871
```
5972

60-
## Screenshot
73+
## Screenshot 📸
6174

6275
<div align="center">
6376

6477
![image](https://github.com/c0m4r/okrutnik/assets/6292788/667464d6-bbf2-4011-bddb-e3234b66b758)
6578

6679
</div>
6780

68-
## Funding
81+
## Funding 💌
6982

7083
If you found this script helpful, please consider [making donation](https://en.wosp.org.pl/fundacja/jak-wspierac-wosp/wesprzyj-online) to a charity on my behalf. Thank you.

0 commit comments

Comments
 (0)