Skip to content

Commit 3fb45cc

Browse files
authored
docs(readme): Add animated gif (#1)
1 parent cb69b59 commit 3fb45cc

6 files changed

Lines changed: 38 additions & 17 deletions

File tree

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ All notable changes to the "command-cycle" extension will be documented in this
44

55
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
66

7+
## [0.1.1] - 2025-03-28
8+
### Added
9+
- Animated GIF illustrating usage (`images/vscode-command-cycle.gif`).
10+
- New `.vsix` package (`command-cycle-0.1.1.vsix`).
11+
12+
### Changed
13+
- Documentation in `README.md` updated to provide clearer instructions.
14+
- Version bump in `package.json` from `0.1.0` to `0.1.1`.
15+
16+
### Removed
17+
- Previous `.vsix` package (`command-cycle-0.1.0.vsix`).
18+
719
## [v0.1.0] - 2025-03-24
820

921
- 🎉 Initial Release:

README.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,31 @@ The **TangoMan vscode-command-cycle** extension for _Visual Studio Code_ enables
1515

1616
### Step 1: Install the Extension
1717

18-
Install the extension directly from the Visual Studio Code marketplace or via the command line:
18+
Launch _VSCode Quick Open_ (`Ctrl+P`), paste the following command, and press `Enter`.
19+
20+
```
21+
ext install TangoMan75.command-cycle
22+
```
23+
24+
Or install the extension via the command line:
1925

2026
```bash
2127
code --install-extension TangoMan75.command-cycle
2228
```
2329

2430
Or install the `.vsix` package manually:
2531

26-
1. Open the Extensions View in VSCOde.
27-
2. Click on the Extensions icon in the Activity Bar.
28-
3. Click on the three dots icon in the top right corner.
29-
4. From the dropdown menu that appears, select "Install from VSIX...".
32+
1. Download the source code.
33+
2. Open the _Extensions View_ in _VSCode_.
34+
3. Click on the Extensions icon in the _Activity Bar_.
35+
4. Click on the three-dot icon (`...`) in the top-right corner.
36+
5. From the dropdown menu that appears, select "`Install from VSIX...`".
3037

3138
### Step 2: Configure Keybindings
3239

33-
Edit your VSCode keybindings configuration in `keybindings.json` file to define the commands to cycle.
40+
Edit your _VSCode_ keybindings configuration in the `keybindings.json` file to define the commands to cycle through.
3441

35-
For example, while using `wmaurer.change-case` extension you can cycle through various text case transformations (e.g., sentence case, title case, camelCase, etc.) by pressing `ctrl+k ctrl+t` repeatedly.
42+
For example, while using the `wmaurer.change-case` extension, you can cycle through various text case transformations (e.g., sentence case, title case, camelCase, etc.) by pressing `Ctrl+K Ctrl+T` repeatedly.
3643

3744
```json
3845
{
@@ -50,12 +57,14 @@ For example, while using `wmaurer.change-case` extension you can cycle through v
5057
},
5158
```
5259

60+
![Loop through case example](./images/vscode-command-cycle.gif)
61+
5362
Replace the commands in the `commands` array with the ones you want to cycle through.
5463

5564
🔥 Usage
5665
--------
5766

58-
1. Press the keybinding you configured (e.g., `ctrl+k ctrl+t`).
67+
1. Press the keybinding you configured (e.g., `Ctrl+K Ctrl+T`).
5968
2. The extension will execute the commands in the order specified in the `commands` array.
6069
3. Each subsequent key press will execute the next command in the cycle.
6170

@@ -70,22 +79,22 @@ Replace the commands in the `commands` array with the ones you want to cycle thr
7079

7180
Thank you for your interest in contributing to **TangoMan vscode-command-cycle**.
7281

73-
Please review the [code of conduct](https://github.com/TangoMan75/vscode-command-cycle/blob/master/CODE_OF_CONDUCT.md) and [contribution guidelines](https://github.com/TangoMan75/vscode-command-cycle/blob/master/CONTRIBUTION.md) before starting to work on any features.
82+
Please review the [Code of Conduct](https://github.com/TangoMan75/vscode-command-cycle/blob/master/CODE_OF_CONDUCT.md) and [Contribution Guidelines](https://github.com/TangoMan75/vscode-command-cycle/blob/master/CONTRIBUTION.md) before starting to work on any features.
7483

75-
If you want to open an issue, please check first if it was not [reported already](https://github.com/TangoMan75/vscode-command-cycle/issues) before creating a new one.
84+
If you want to open an issue, please check first if it has not been [reported already](https://github.com/TangoMan75/vscode-command-cycle/issues) before creating a new one.
7685

7786
📜 License
7887
----------
7988

80-
Copyrights (c) 2025 "Matthias Morin" <mat@tangoman.io>
89+
Copyright (c) 2025 "Matthias Morin" <mat@tangoman.io>
8190

82-
[![License](https://img.shields.io/badge/Licence-MIT-green.svg)](LICENSE)
91+
[![License](https://img.shields.io/badge/Licence-MIT-green.svg)](LICENSE)
8392
Distributed under the MIT license.
8493

85-
If you like **TangoMan vscode-command-cycle** please star, follow or tweet:
94+
If you like **TangoMan vscode-command-cycle**, please star, follow, or tweet:
8695

87-
[![GitHub stars](https://img.shields.io/github/stars/TangoMan75/vscode-command-cycle?style=social)](https://github.com/TangoMan75/vscode-command-cycle/stargazers)
88-
[![GitHub followers](https://img.shields.io/github/followers/TangoMan75?style=social)](https://github.com/TangoMan75)
96+
[![GitHub stars](https://img.shields.io/github/stars/TangoMan75/vscode-command-cycle?style=social)](https://github.com/TangoMan75/vscode-command-cycle/stargazers)
97+
[![GitHub followers](https://img.shields.io/github/followers/TangoMan75?style=social)](https://github.com/TangoMan75)
8998
[![Twitter](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2FTangoMan75%2Fvscode-command-cycle)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2FTangoMan75%2Fvscode-command-cycle)
9099

91-
... And check my other cool projects.
100+
... And check out my other cool projects.

command-cycle-0.1.0.vsix

-10.9 KB
Binary file not shown.

command-cycle-0.1.1.vsix

735 KB
Binary file not shown.

images/vscode-command-cycle.gif

727 KB
Loading

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "command-cycle",
33
"displayName": "Command Cycle",
44
"description": "Loop through the repeated execution of a user-defined sequence of commands with every press of the same keybinding",
5-
"version": "0.1.0",
5+
"version": "0.1.1",
66
"publisher": "TangoMan75",
77
"license": "MIT",
88
"repository": {

0 commit comments

Comments
 (0)