Skip to content

Commit 2271f69

Browse files
committed
docs: Add plugin description and images into README.md
1 parent 250a453 commit 2271f69

File tree

1 file changed

+45
-8
lines changed

1 file changed

+45
-8
lines changed

README.md

Lines changed: 45 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,29 @@
55
[![Downloads](https://img.shields.io/jetbrains/plugin/d/21896-codexp.svg)](https://plugins.jetbrains.com/plugin/21896-codexp)
66

77
<!-- Plugin description -->
8-
The CodeXP plugin is designed to gamify your coding experience in IntelliJ IDEs. It provides the following features:
8+
The CodeXP plugin is designed to gamify your coding experience in IntelliJ IDEs.
9+
10+
## Features
11+
12+
---
913

1014
- Awards experience points (xp) for various actions such as:
1115
- Typing
12-
- Building
13-
- Running
14-
- Creating functions
15-
- Searching
16-
- Replacing
17-
- Commit/Push/Pull
18-
- Displays effects corresponding to the actions performed.
16+
- Paste
17+
- Backspace / Tab
18+
- Save
19+
- Build / Run / Debug
20+
- Other actions
1921
- Provides periodic challenges to keep the coding experience engaging.
2022
- Displays your level based on the accumulated xp, providing a fun and engaging way to track your coding activities.
2123
<!-- Plugin description end -->
2224

25+
<br>
26+
2327
## Installation
2428

29+
---
30+
2531
- Using IDE built-in plugin system:
2632

2733
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "CodeXP"</kbd> >
@@ -34,6 +40,37 @@ The CodeXP plugin is designed to gamify your coding experience in IntelliJ IDEs.
3440
Download the [latest release](https://github.com/ILoveGameCoding/intellij-codexp/releases/latest) and install it manually using
3541
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>
3642

43+
<br>
44+
45+
## Dashboard in Light/Dark Theme
46+
47+
---
48+
49+
<p float="left">
50+
<img src="https://github.com/ILoveGameCoding/intellij-codexp/blob/main/images/dashboard_light_1.png" width="400" />
51+
<img src="https://github.com/ILoveGameCoding/intellij-codexp/blob/main/images/dashboard_light_2.png" width="400" />
52+
</p>
53+
<p float="left">
54+
<img src="https://github.com/ILoveGameCoding/intellij-codexp/blob/main/images/dashboard_dark_1.png" width="400" />
55+
<img src="https://github.com/ILoveGameCoding/intellij-codexp/blob/main/images/dashboard_dark_2.png" width="400" />
56+
</p>
57+
58+
<br>
59+
60+
## Completed Challenges
61+
62+
---
63+
64+
Completed challenges are added under the "Completed Challenges" section. Also, more difficult challenges are automatically added after you complete a challenge.
65+
66+
![Completed Challenges](https://github.com/ILoveGameCoding/intellij-codexp/blob/main/images/completed_challenges.png)
67+
68+
<br>
69+
70+
## Notification
71+
Whenever a challenge is completed or a level up occurs, a notification is provided to inform you of the details.
72+
73+
![Notification](https://github.com/ILoveGameCoding/intellij-codexp/blob/main/images/notification.jpg")
3774

3875
---
3976
Plugin based on the [IntelliJ Platform Plugin Template][template].

0 commit comments

Comments
 (0)