Skip to content

Commit 01ad63a

Browse files
committed
chore: spice up README and add contributors
1 parent 39a7f63 commit 01ad63a

File tree

2 files changed

+116
-17
lines changed

2 files changed

+116
-17
lines changed

.github/workflows/contributors.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Update Contributors
2+
3+
on:
4+
schedule:
5+
- cron: '0 0 * * *' # Run daily at midnight UTC
6+
workflow_dispatch: # Allow manual trigger
7+
8+
jobs:
9+
contributors:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
with:
14+
token: ${{ secrets.CONTRIBUTORS_TOKEN }}
15+
16+
- name: Update contributors
17+
env:
18+
GH_TOKEN: ${{ secrets.CONTRIBUTORS_TOKEN }}
19+
run: |
20+
# Fetch contributors from GitHub API (exclude bots)
21+
contributors=$(gh api repos/CodingWithCalvin/VS-OpenInNotepadPlusPlus/contributors --paginate --jq '.[] | select(.type != "Bot") | select(.login | test("\\[bot\\]$") | not) | "<a href=\"\(.html_url)\"><img src=\"\(.avatar_url)\" width=\"64\" height=\"64\" alt=\"\(.login)\"/></a>"')
22+
23+
# Build the contributors section
24+
contrib_section="<!-- readme: contributors -start -->
25+
<p align=\"left\">
26+
$contributors
27+
</p>
28+
<!-- readme: contributors -end -->"
29+
30+
# Update README between the markers
31+
awk -v contrib="$contrib_section" '
32+
/<!-- readme: contributors -start -->/{found=1; print contrib; next}
33+
/<!-- readme: contributors -end -->/{found=0; next}
34+
!found{print}
35+
' README.md > README.tmp && mv README.tmp README.md
36+
37+
- name: Commit and push
38+
run: |
39+
git config user.name "github-actions[bot]"
40+
git config user.email "github-actions[bot]@users.noreply.github.com"
41+
git add README.md
42+
git diff --staged --quiet || (git commit -m "docs: update contributors [skip ci]" && git push)

README.md

Lines changed: 74 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,89 @@
1-
# Open in Notepad++
1+
<p align="center">
2+
<img src="resources/logo.png" alt="Open in Notepad++ Logo" width="128" height="128">
3+
</p>
24

3-
A Visual Studio extension that adds a right-click context menu command that allows you to open the solution file, project file, or file in Notepad++.
5+
<h1 align="center">Open in Notepad++</h1>
46

5-
## License
7+
<p align="center">
8+
<strong>🚀 Instantly open any file from Visual Studio in Notepad++!</strong>
9+
</p>
610

7-
[![License - MIT](https://img.shields.io/github/license/CodingWithCalvin/VS-OpenInNotepadPlusPlus?style=for-the-badge)](https://img.shields.io/github/license/codingwithcalvin/VS-OpenInNotepadPlusPlus?style=for-the-badge)
11+
<p align="center">
12+
<a href="https://github.com/CodingWithCalvin/VS-OpenInNotepadPlusPlus/blob/main/LICENSE">
13+
<img src="https://img.shields.io/github/license/CodingWithCalvin/VS-OpenInNotepadPlusPlus?style=for-the-badge" alt="License">
14+
</a>
15+
<a href="https://github.com/CodingWithCalvin/VS-OpenInNotepadPlusPlus/actions/workflows/release_build_and_deploy.yml">
16+
<img src="https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-OpenInNotepadPlusPlus/release_build_and_deploy.yml?style=for-the-badge" alt="Build Status">
17+
</a>
18+
</p>
819

9-
## Build Status
20+
<p align="center">
21+
<a href="https://marketplace.visualstudio.com/items?itemName=codingwithcalvin.VS-OpenInNotepadPlusPlus">
22+
<img src="https://img.shields.io/visual-studio-marketplace/v/codingwithcalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge" alt="Marketplace Version">
23+
</a>
24+
<a href="https://marketplace.visualstudio.com/items?itemName=codingwithcalvin.VS-OpenInNotepadPlusPlus">
25+
<img src="https://img.shields.io/visual-studio-marketplace/i/codingwithcalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge" alt="Marketplace Installations">
26+
</a>
27+
<a href="https://marketplace.visualstudio.com/items?itemName=codingwithcalvin.VS-OpenInNotepadPlusPlus">
28+
<img src="https://img.shields.io/visual-studio-marketplace/d/codingwithcalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge" alt="Marketplace Downloads">
29+
</a>
30+
<a href="https://marketplace.visualstudio.com/items?itemName=codingwithcalvin.VS-OpenInNotepadPlusPlus">
31+
<img src="https://img.shields.io/visual-studio-marketplace/r/codingwithcalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge" alt="Marketplace Rating">
32+
</a>
33+
</p>
1034

11-
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-OpenInNotepadPlusPlus/release_build_and_deploy.yml?style=for-the-badge)
35+
---
1236

13-
## Marketplace Status
37+
## ✨ Features
1438

15-
[![Marketplace Installations](https://img.shields.io/visual-studio-marketplace/i/codingwithcalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge)](https://img.shields.io/visual-studio-marketplace/i/codingwithcalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge) [![Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/codingwithcalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge)](https://img.shields.io/visual-studio-marketplace/d/codingwithcalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge)
16-
[![Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/codingwithcalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge)](https://img.shields.io/visual-studio-marketplace/v/codingwithcalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge) [![Marketplace Rating](https://img.shields.io/visual-studio-marketplace/r/codingwithcalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge)](https://img.shields.io/visual-studio-marketplace/r/codingwithcalvin.VS-OpenInNotepadPlusPlus?style=for-the-badge)
39+
- **Right-click to open** - Open any file directly from Solution Explorer
40+
- **Works everywhere** - Solutions, projects, folders, and individual files
41+
- **Auto-detection** - Automatically finds Notepad++ in the default install location
42+
- **Configurable** - Custom executable path via Tools > Options
1743

18-
## Prerequisite
44+
## 📋 Prerequisites
1945

20-
In order to use this extension, you must have Notepad++ installed.
46+
This extension requires [Notepad++](https://notepad-plus-plus.org/) to be installed on your machine.
2147

22-
You can [download Notepad++ for free](https://notepad-plus-plus.org/).
48+
## ⚙️ Configuration
2349

24-
## Settings
50+
The extension automatically detects `notepad++.exe` in the default installation directory. If you've installed Notepad++ to a custom location, configure the path in **Tools > Options > Open in Notepad++**.
2551

26-
The extension will automatically find `notepad++.exe` when it's located at in the default install directory. If it's installed in a custom location, you can easily change it in the settings dialog.
52+
## 🛠️ Installation
2753

28-
## Contributions
54+
### Visual Studio Marketplace
2955

30-
Contributions are welcome! Issues, PRs, etc. While it may seem this extension is "done", who knows what the future may hold for it?
56+
1. Open Visual Studio 2022
57+
2. Go to **Extensions > Manage Extensions**
58+
3. Search for "Open in Notepad++"
59+
4. Click **Download** and restart Visual Studio
3160

32-
For cloning and building this project yourself, make sure to install the [Extensibility Essentials 2022 extension](https://marketplace.visualstudio.com/items?itemName=MadsKristensen.ExtensibilityEssentials2022) for Visual Studio which enables some features used by this project.
61+
### Manual Installation
62+
63+
Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCalvin/VS-OpenInNotepadPlusPlus/releases) page and double-click to install.
64+
65+
## 🤝 Contributing
66+
67+
Contributions are welcome! Whether it's bug reports, feature requests, or pull requests - all feedback helps make this extension better.
68+
69+
### Development Setup
70+
71+
1. Clone the repository
72+
2. Install [Extensibility Essentials 2022](https://marketplace.visualstudio.com/items?itemName=MadsKristensen.ExtensibilityEssentials2022)
73+
3. Open `src/CodingWithCalvin.OpenInNotepadPlusPlus.slnx` in Visual Studio
74+
4. Press F5 to launch the experimental instance
75+
76+
## 📄 License
77+
78+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
79+
80+
---
81+
82+
## 👥 Contributors
83+
84+
<!-- readme: contributors -start -->
85+
<!-- readme: contributors -end -->
86+
87+
<p align="center">
88+
Made with ❤️ by <a href="https://github.com/CalvinAllen">Calvin Allen</a>
89+
</p>

0 commit comments

Comments
 (0)