Skip to content

Commit 3ca81b1

Browse files
committed
Update GitHub username from Unix-like-SoN to makepkg in all documentation
1 parent 16d385e commit 3ca81b1

8 files changed

Lines changed: 266 additions & 23 deletions

File tree

.github/QUICK_SETUP.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ gh repo edit Unix-like-SoN/SecureGen \
6060
--description "🔐 Hardware TOTP Authenticator & Password Manager | 7-layer security | AES-256 | BLE Keyboard | Offline | ESP32 T-Display"
6161

6262
# Set homepage
63-
gh repo edit Unix-like-SoN/SecureGen \
64-
--homepage "https://github.com/Unix-like-SoN/SecureGen"
63+
gh repo edit makepkg/SecureGen \
64+
--homepage "https://github.com/makepkg/SecureGen"
6565

6666
# Enable features
6767
gh repo edit Unix-like-SoN/SecureGen \
@@ -107,13 +107,13 @@ gh repo edit Unix-like-SoN/SecureGen \
107107

108108
### Step 1: Update About Section
109109

110-
1. Go to: https://github.com/Unix-like-SoN/SecureGen
110+
1. Go to: https://github.com/makepkg/SecureGen
111111
2. Click ⚙️ (gear icon) in "About" section (right sidebar)
112112
3. Paste this description:
113113
```
114114
🔐 Hardware TOTP Authenticator & Password Manager | 7-layer security | AES-256 | BLE Keyboard | Offline | ESP32 T-Display
115115
```
116-
4. Add website: `https://github.com/Unix-like-SoN/SecureGen`
116+
4. Add website: `https://github.com/makepkg/SecureGen`
117117
5. Click "Topics" and add these (comma-separated):
118118
```
119119
esp32, totp, password-manager, security, authentication, 2fa, two-factor-authentication, arduino, platformio, embedded, iot, hardware, lilygo, t-display, encryption, aes-256, bluetooth-le, ble, offline, air-gapped, open-source, authenticator, otp, password-vault, security-device, hardware-security
@@ -123,7 +123,7 @@ gh repo edit Unix-like-SoN/SecureGen \
123123

124124
### Step 2: Enable Features
125125

126-
1. Go to: https://github.com/Unix-like-SoN/SecureGen/settings
126+
1. Go to: https://github.com/makepkg/SecureGen/settings
127127
2. Under "Features":
128128
- ✅ Issues
129129
- ✅ Discussions
@@ -154,7 +154,7 @@ gh repo view Unix-like-SoN/SecureGen
154154
gh api repos/Unix-like-SoN/SecureGen --jq '.topics'
155155
```
156156

157-
Or visit: https://github.com/Unix-like-SoN/SecureGen
157+
Or visit: https://github.com/makepkg/SecureGen
158158

159159
---
160160

.github/REPOSITORY_SETUP.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This guide helps you configure the GitHub repository metadata, topics, and setti
1717

1818
**Website:** (Optional)
1919
```
20-
https://github.com/Unix-like-SoN/SecureGen
20+
https://github.com/makepkg/SecureGen
2121
```
2222

2323
---
@@ -176,8 +176,8 @@ gh repo edit Unix-like-SoN/SecureGen \
176176
--enable-discussions
177177

178178
# Set homepage
179-
gh repo edit Unix-like-SoN/SecureGen \
180-
--homepage "https://github.com/Unix-like-SoN/SecureGen"
179+
gh repo edit makepkg/SecureGen \
180+
--homepage "https://github.com/makepkg/SecureGen"
181181
```
182182

183183
### Method 3: GitHub API (curl)
@@ -194,7 +194,7 @@ curl -X PATCH \
194194
https://api.github.com/repos/$REPO \
195195
-d '{
196196
"description": "🔐 Hardware TOTP Authenticator & Password Manager | 7-layer security | AES-256 | BLE Keyboard | Offline | ESP32 T-Display",
197-
"homepage": "https://github.com/Unix-like-SoN/SecureGen",
197+
"homepage": "https://github.com/makepkg/SecureGen",
198198
"topics": [
199199
"esp32", "totp", "password-manager", "security", "authentication",
200200
"2fa", "two-factor-authentication", "arduino", "platformio", "embedded",

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Thank you for your interest in contributing! This document provides guidelines f
2222

2323
### Reporting Bugs
2424

25-
1. Check if the bug is already reported in [Issues](https://github.com/Unix-like-SoN/SecureGen/issues)
25+
1. Check if the bug is already reported in [Issues](https://github.com/makepkg/SecureGen/issues)
2626
2. Create a new issue with:
2727
- Clear title and description
2828
- Steps to reproduce
@@ -32,7 +32,7 @@ Thank you for your interest in contributing! This document provides guidelines f
3232

3333
### Suggesting Features
3434

35-
1. Check [Discussions](https://github.com/Unix-like-SoN/SecureGen/discussions) for similar ideas
35+
1. Check [Discussions](https://github.com/makepkg/SecureGen/discussions) for similar ideas
3636
2. Create a new discussion with:
3737
- Clear description of the feature
3838
- Use cases and benefits
@@ -65,7 +65,7 @@ git clone https://github.com/YOUR_USERNAME/SecureGen.git
6565
cd SecureGen
6666

6767
# Add upstream remote
68-
git remote add upstream https://github.com/Unix-like-SoN/SecureGen.git
68+
git remote add upstream https://github.com/makepkg/SecureGen.git
6969

7070
# Install dependencies (PlatformIO handles this)
7171
pio lib install
@@ -231,8 +231,8 @@ How was this tested?
231231

232232
## Questions?
233233

234-
- Open a [Discussion](https://github.com/Unix-like-SoN/SecureGen/discussions)
235-
- Check existing [Issues](https://github.com/Unix-like-SoN/SecureGen/issues)
234+
- Open a [Discussion](https://github.com/makepkg/SecureGen/discussions)
235+
- Check existing [Issues](https://github.com/makepkg/SecureGen/issues)
236236
- Read the [Documentation](docs/)
237237

238238
## Recognition

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@
136136

137137
1. **Clone the repository**
138138
```bash
139-
git clone https://github.com/Unix-like-SoN/SecureGen.git
139+
git clone https://github.com/makepkg/SecureGen.git
140140
cd SecureGen
141141
```
142142

@@ -374,8 +374,8 @@ This device implements **7+ layers of security** for protecting your sensitive d
374374
## 🤝 Support
375375

376376
### Get Help
377-
- **Issues:** [GitHub Issues](https://github.com/Unix-like-SoN/SecureGen/issues)
378-
- **Discussions:** [GitHub Discussions](https://github.com/Unix-like-SoN/SecureGen/discussions)
377+
- **Issues:** [GitHub Issues](https://github.com/makepkg/SecureGen/issues)
378+
- **Discussions:** [GitHub Discussions](https://github.com/makepkg/SecureGen/discussions)
379379
- **Documentation:** [Project Wiki](docs/)
380380

381381
### Contributing

REDDIT_POST.md

Lines changed: 243 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,243 @@
1+
# Reddit Post Template for SecureGen
2+
3+
## 📋 Recommended Subreddits (in order of priority):
4+
5+
1. **r/esp32** - Main ESP32 community (most relevant)
6+
2. **r/arduino** - Arduino/embedded projects
7+
3. **r/embedded** - Embedded systems
8+
4. **r/cybersecurity** - Security focus
9+
5. **r/privacy** - Privacy-focused audience
10+
6. **r/selfhosted** - Self-hosted solutions
11+
7. **r/opensource** - Open source projects
12+
8. **r/LILYGO** - LILYGO hardware specific
13+
9. **r/maker** - Maker community
14+
10. **r/electronics** - Electronics enthusiasts
15+
16+
---
17+
18+
## 📝 Post Title Options:
19+
20+
**Option 1 (Technical):**
21+
```
22+
[Project] SecureGen - Open-source Hardware TOTP Authenticator & Password Manager on ESP32 T-Display
23+
```
24+
25+
**Option 2 (Feature-focused):**
26+
```
27+
I built a hardware 2FA authenticator with password manager using ESP32 T-Display (Open Source)
28+
```
29+
30+
**Option 3 (Problem-solving):**
31+
```
32+
Tired of phone-based authenticators? Built an offline hardware TOTP device with ESP32
33+
```
34+
35+
---
36+
37+
## 📄 Post Content (Markdown format for Reddit):
38+
39+
```markdown
40+
# SecureGen - Hardware TOTP Authenticator & Password Manager
41+
42+
Hi r/esp32! I've been working on an open-source security device and just released v1.0.0. Thought you might find it interesting!
43+
44+
## 🔐 What is it?
45+
46+
SecureGen is a hardware-based TOTP authenticator (like Google Authenticator) combined with a password manager, built on the LILYGO ESP32 T-Display. It's completely offline and air-gapped for maximum security.
47+
48+
## ✨ Key Features
49+
50+
- **TOTP Authenticator** - RFC 6238 compliant, 30/60 second codes
51+
- **Password Manager** - Encrypted vault with 256-bit AES
52+
- **BLE Keyboard** - Types passwords directly into your computer
53+
- **7+ Security Layers** - PBKDF2, traffic obfuscation, anti-timing attacks
54+
- **Web Interface** - Easy management via WiFi
55+
- **Battery Powered** - Portable with JST battery connector
56+
- **Dual Themes** - Light/Dark mode support
57+
- **Offline First** - No cloud, no internet required for operation
58+
59+
## 🎯 Why I Built This
60+
61+
I wanted a physical 2FA device that:
62+
- Doesn't rely on my phone
63+
- Works completely offline
64+
- Stores passwords securely
65+
- Is open source and auditable
66+
- Can type passwords via BLE keyboard
67+
68+
## 📦 What's Included
69+
70+
The v1.0.0 release includes:
71+
- Pre-compiled firmware binaries (ready to flash)
72+
- Full source code
73+
- Documentation and setup guides
74+
- Web interface for management
75+
76+
## 🛠️ Hardware Requirements
77+
78+
- LILYGO T-Display ESP32 (~$15 on AliExpress)
79+
- USB-C cable for programming
80+
- Optional: 3.7V LiPo battery with JST connector
81+
82+
## 🚀 Installation
83+
84+
Three options:
85+
1. **Flash pre-built binaries** (easiest - just download and flash)
86+
2. **Build from source** with PlatformIO
87+
3. **Use Arduino IDE**
88+
89+
Full instructions in the repo!
90+
91+
## 📸 Screenshots
92+
93+
[Add your screenshots here when you have them]
94+
95+
## 🔗 Links
96+
97+
- **GitHub Repository:** https://github.com/makepkg/SecureGen
98+
- **Latest Release:** https://github.com/makepkg/SecureGen/releases/tag/v1.0.0
99+
- **Documentation:** https://github.com/makepkg/SecureGen/blob/master/README.md
100+
101+
## 🤝 Contributing
102+
103+
This is fully open source (MIT License). Contributions, bug reports, and feature requests are welcome!
104+
105+
## 💭 Questions?
106+
107+
Happy to answer any questions about the project, security architecture, or implementation details!
108+
109+
---
110+
111+
**Tech Stack:** ESP32, Arduino Framework, TFT_eSPI, BLE, AES-256, PBKDF2, ECDH
112+
113+
**License:** MIT
114+
115+
If you find this useful, a ⭐ on GitHub would be appreciated!
116+
```
117+
118+
---
119+
120+
## 🎨 Post with Images (Alternative format):
121+
122+
If you have screenshots ready, use this format:
123+
124+
```markdown
125+
# [Project] SecureGen - Hardware TOTP + Password Manager on ESP32
126+
127+
[Image 1: Device showing TOTP code]
128+
129+
Just released v1.0.0 of my open-source hardware authenticator project!
130+
131+
**What it does:**
132+
- Generates TOTP codes (like Google Authenticator)
133+
- Stores passwords in encrypted vault
134+
- Types passwords via BLE keyboard
135+
- Completely offline and air-gapped
136+
137+
[Image 2: Web interface]
138+
139+
**Hardware:** LILYGO T-Display ESP32 (~$15)
140+
141+
**Security:** 7+ layers including AES-256, PBKDF2, traffic obfuscation
142+
143+
[Image 3: Different screens/modes]
144+
145+
**Features:**
146+
✅ Battery powered & portable
147+
✅ Web-based management
148+
✅ Light/Dark themes
149+
✅ Factory reset protection
150+
✅ PIN code lock
151+
152+
**Download:** Pre-built firmware ready to flash!
153+
154+
🔗 GitHub: https://github.com/makepkg/SecureGen
155+
📦 Release: https://github.com/makepkg/SecureGen/releases/tag/v1.0.0
156+
157+
Open source (MIT) - contributions welcome!
158+
159+
AMA about the project! 🚀
160+
```
161+
162+
---
163+
164+
## 📊 Posting Strategy:
165+
166+
### Timing:
167+
- **Best days:** Tuesday-Thursday
168+
- **Best time:** 8-10 AM EST or 2-4 PM EST
169+
- Avoid weekends for technical subs
170+
171+
### Engagement Tips:
172+
1. **Respond quickly** to comments in first 2 hours
173+
2. **Be helpful** - answer technical questions
174+
3. **Share details** about challenges you faced
175+
4. **Add flair** if subreddit requires it
176+
5. **Cross-post** after 24 hours to other relevant subs
177+
178+
### What to Prepare:
179+
- [ ] High-quality photos of device
180+
- [ ] GIF/video of it in action (optional but great)
181+
- [ ] Screenshots of web interface
182+
- [ ] Be ready to answer questions about:
183+
- Security implementation
184+
- Why not use phone apps
185+
- Hardware cost
186+
- Battery life
187+
- Comparison to YubiKey/other devices
188+
189+
### Follow Reddit Rules:
190+
- Check each subreddit's rules before posting
191+
- Some require [Project] or [OC] tags
192+
- Some have specific days for project posts
193+
- Don't spam multiple subs at once (space out by 24h)
194+
195+
---
196+
197+
## 🎯 Expected Questions & Answers:
198+
199+
**Q: Why not just use Google Authenticator on phone?**
200+
A: This is for people who want a dedicated, offline device. Phone can be lost, hacked, or out of battery. This is air-gapped and purpose-built.
201+
202+
**Q: How is this different from YubiKey?**
203+
A: YubiKey is hardware-only (no screen). This has a display showing codes, stores passwords, and can type them via BLE. Also it's open source and $15 vs $50+.
204+
205+
**Q: Is it secure to have WiFi on a security device?**
206+
A: WiFi is only for initial setup and management. During normal operation, you can disable WiFi completely. TOTP generation works 100% offline.
207+
208+
**Q: Battery life?**
209+
A: Several days of active use, weeks on standby. Depends on usage patterns and battery capacity.
210+
211+
**Q: Can I audit the security?**
212+
A: Yes! Full source code is available. Security documentation explains all layers. That's the point of open source.
213+
214+
---
215+
216+
## 📈 Success Metrics:
217+
218+
Good post performance:
219+
- 50+ upvotes in first 24h
220+
- 10+ comments with questions
221+
- 5+ GitHub stars from Reddit traffic
222+
223+
Great post performance:
224+
- 200+ upvotes
225+
- 30+ comments
226+
- 20+ GitHub stars
227+
- Cross-posts to other subs
228+
229+
---
230+
231+
## 🔄 Follow-up Posts (Future):
232+
233+
After initial release, you can post updates:
234+
- "v1.1.0 released with [new features]"
235+
- "Tutorial: How I implemented [specific feature]"
236+
- "Lessons learned building a hardware security device"
237+
- "Community requested features now live"
238+
239+
---
240+
241+
**Ready to post? Start with r/esp32 - it's the most relevant community!**
242+
243+
Good luck! 🚀

SUPPORT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Thank you for considering supporting the ESP32 T-Display TOTP project! Your supp
1010

1111
The simplest way to show your support is to star this repository on GitHub. It helps increase visibility and encourages continued development.
1212

13-
[![Star on GitHub](https://img.shields.io/github/stars/Unix-like-SoN/SecureGen?style=social)](https://github.com/Unix-like-SoN/SecureGen)
13+
[![Star on GitHub](https://img.shields.io/github/stars/makepkg/SecureGen?style=social)](https://github.com/makepkg/SecureGen)
1414

1515
### 2. Contribute Code 💻
1616

@@ -172,7 +172,7 @@ Every form of support - whether it's code, feedback, or financial - is greatly a
172172
## 📞 Contact
173173

174174
For questions about donations or sponsorship:
175-
- Open a [Discussion](https://github.com/Unix-like-SoN/SecureGen/discussions)
175+
- Open a [Discussion](https://github.com/makepkg/SecureGen/discussions)
176176
- Contact via GitHub profile
177177

178178
---

0 commit comments

Comments
 (0)