Skip to content

Commit 1ab11dd

Browse files
committed
feat: add Gumroad support link and Homebrew tap setup guide
- Added Gumroad support link (https://kiku0.gumroad.com/coffee) to floating support button - Added Gumroad link to support snackbar - Added Gumroad link to README support section - Created HOMEBREW_TAP_SETUP.md with detailed step-by-step instructions - Updated app.js version to v39
1 parent e749e9d commit 1ab11dd

File tree

4 files changed

+77
-2
lines changed

4 files changed

+77
-2
lines changed

HOMEBREW_TAP_SETUP.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Homebrew Tap Setup Instructions
2+
3+
## Quick Setup
4+
5+
1. **Create a new repository on GitHub:**
6+
- Repository name: `homebrew-docstripper`
7+
- Make it public
8+
- Don't initialize with README
9+
10+
2. **Clone and setup locally:**
11+
```bash
12+
git clone https://github.com/YOUR_USERNAME/homebrew-docstripper.git
13+
cd homebrew-docstripper
14+
mkdir -p Formula
15+
```
16+
17+
3. **Copy and update the formula:**
18+
```bash
19+
cp ../DocStripper/docstripper.rb Formula/docstripper.rb
20+
```
21+
22+
4. **Update the formula URL to point to GitHub releases:**
23+
24+
Edit `Formula/docstripper.rb` and update:
25+
```ruby
26+
url "https://github.com/kiku-jw/DocStripper/archive/refs/tags/v2.1.0.tar.gz"
27+
sha256 "" # Calculate with: shasum -a 256 <downloaded_file>
28+
```
29+
30+
5. **Calculate SHA256:**
31+
```bash
32+
# Download the release tarball first
33+
curl -L https://github.com/kiku-jw/DocStripper/archive/refs/tags/v2.1.0.tar.gz -o docstripper.tar.gz
34+
shasum -a 256 docstripper.tar.gz
35+
# Copy the hash to the formula
36+
```
37+
38+
6. **Commit and push:**
39+
```bash
40+
git add Formula/docstripper.rb
41+
git commit -m "Add docstripper formula"
42+
git push origin main
43+
```
44+
45+
7. **Users can now install with:**
46+
```bash
47+
brew tap YOUR_USERNAME/docstripper
48+
brew install docstripper
49+
```
50+
51+
## Formula Template (for reference)
52+
53+
The formula is already created in `docstripper.rb`. Make sure it has:
54+
- Correct URL pointing to GitHub releases
55+
- Correct SHA256 hash
56+
- Proper dependencies
57+
58+
## Updating the Formula
59+
60+
When releasing a new version:
61+
1. Update the URL to the new release tag
62+
2. Calculate new SHA256 hash
63+
3. Update version in formula
64+
4. Commit and push to tap repo
65+
66+
## Testing
67+
68+
Before pushing, test locally:
69+
```bash
70+
brew install --build-from-source Formula/docstripper.rb
71+
brew test docstripper
72+
```

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines
214214

215215
Support this project and help keep it free:
216216

217-
[☕ Buy Me a Coffee](https://buymeacoffee.com/kiku) | [🙏 Thanks.dev](https://thanks.dev/d/gh/kiku-jw) | [💚 Ko-fi](https://ko-fi.com/kiku_jw)
217+
[Support on Gumroad](https://kiku0.gumroad.com/coffee) | [Buy Me a Coffee](https://buymeacoffee.com/kiku) | [🙏 Thanks.dev](https://thanks.dev/d/gh/kiku-jw) | [💚 Ko-fi](https://ko-fi.com/kiku_jw)
218218

219219
## 🔗 Connect
220220

docs/assets/app.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2720,7 +2720,7 @@ class App {
27202720
snackbar.className = 'support-snackbar';
27212721
snackbar.innerHTML = `
27222722
<div class="snackbar-content">
2723-
<span class="snackbar-text">Saved you some time? ☕ <a href="https://buymeacoffee.com/kiku" target="_blank" rel="noopener">Buy a coffee</a></span>
2723+
<span class="snackbar-text">Saved you some time? ☕ <a href="https://kiku0.gumroad.com/coffee" target="_blank" rel="noopener">Support on Gumroad</a></span>
27242724
<button class="snackbar-close" aria-label="Close">×</button>
27252725
</div>
27262726
`;

docs/index.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -514,6 +514,9 @@ <h3>Clean Output</h3>
514514
<button class="support-close" id="supportClose" aria-label="Close">×</button>
515515
</div>
516516
<div class="support-menu-links">
517+
<a href="https://kiku0.gumroad.com/coffee" target="_blank" rel="noopener noreferrer" class="support-link">
518+
<span></span> Support on Gumroad
519+
</a>
517520
<a href="https://buymeacoffee.com/kiku" target="_blank" rel="noopener noreferrer" class="support-link">
518521
<span></span> Buy Me a Coffee
519522
</a>

0 commit comments

Comments
 (0)