Skip to content

Commit c31330e

Browse files
committed
Improve README.md
1 parent 67ff0e7 commit c31330e

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,29 @@
55
<!-- Plugin description -->
66
This plugin _(quite decently)_ implements inlay parameter hints for **Python**.
77

8-
## Supported expressions
8+
## Installation
9+
10+
- Using IDE built-in plugin system:
11+
12+
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> >
13+
<kbd>Search for "Python Inlay Params"</kbd> > <kbd>Install Plugin</kbd>
14+
15+
- Manually:
16+
17+
Download the [latest release](https://github.com/WhiteMemory99/intellij-python-inlay-params/releases/latest) and
18+
install it manually using
19+
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>
20+
21+
## Supported expressions
922

1023
Pretty much any expression is supported:
24+
1125
* dataclass and class instantiation
1226
* lambdas
1327
* decorators
1428
* function calls
15-
* etc.
29+
* etc.
30+
1631
<!-- Plugin description end -->
1732

1833
**Look at the examples below to see how it works.**
@@ -21,7 +36,7 @@ Pretty much any expression is supported:
2136

2237
The plugin can be disabled anytime in IDE settings:
2338

24-
#### Settings -> Editor -> Inlay Hints -> Parameter names -> Python
39+
<kbd>Settings</kbd> -> <kbd>Editor</kbd> -> <kbd>Inlay Hints</kbd> -> <kbd>Parameter names</kbd> -> <kbd>Python</kbd>
2540

2641
## Demo Screenshots
2742

0 commit comments

Comments
 (0)