https://github.com/dubsopenhub/my-ai-readme
My AI Readme - How to work with me, powered by GitHub Copilot CLI
https://github.com/dubsopenhub/my-ai-readme
Last synced: 1 day ago
JSON representation
My AI Readme - How to work with me, powered by GitHub Copilot CLI
- Host: GitHub
- URL: https://github.com/dubsopenhub/my-ai-readme
- Owner: DUBSOpenHub
- License: mit
- Created: 2026-02-11T21:25:58.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-03-28T08:02:59.000Z (4 months ago)
- Last Synced: 2026-07-07T22:21:29.499Z (23 days ago)
- Language: JavaScript
- Homepage:
- Size: 93.8 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Roadmap: ROADMAP.md
Awesome Lists containing this project
README
# 🤖 My AI README: How to Work With Me
> **"How to Work With Me" — AI-powered team profiles, built in 3 minutes.**
My AI README is a GitHub Copilot CLI agent that helps every team member create a polished "How to Work With Me" profile through a fun, guided conversation. No writing skills required — just answer a few questions and the AI does the rest.
> ⚡ **Get started fast!** Copy this right into the [Copilot CLI](https://github.com/github/copilot-cli):
> ```
> /skills add DUBSOpenHub/My-AI-Readme
> ```
## ✨ What You Get
A beautiful Markdown profile that tells your teammates:
- 📬 How to reach you (email, LinkedIn, timezone)
- 💬 Your communication style and preferences
- ⚡ Your superpower at work
- 🔋 What drains your energy (so people can avoid it!)
- 🎲 Fun facts that make you *you*
## 🚀 Quickstart (2 minutes)
### Prerequisites
- [GitHub CLI (`gh`)](https://cli.github.com/) installed and authenticated (`gh auth login`)
### Step 1: Install the extension
```bash
gh extension install DUBSOpenHub/My-AI-Readme
```
### Step 2: Build your profile
```bash
gh my-ai-readme
```
That's it! The extension handles everything — installs Copilot CLI if needed, sets up the repo, and launches the profile builder. Just type `@my-ai-readme` when prompted. 🎉
### Step 3: Share with your team
The agent saves your profile and walks you through committing. Or do it manually:
```bash
cd ~/.my-ai-readme
git add profiles/
git commit -m "Add my profile 🤖"
git push
```
## 📚 Browse Profiles
Check out the [team directory](profiles/README.md) to see everyone's profiles.
### 🌐 GitHub Pages
This repo is GitHub Pages-ready. To enable the web directory:
1. Go to **Settings → Pages** in your GitHub repo
2. Set source to **Deploy from a branch → `main` / `/ (root)`**
3. Your team directory will be live at `https://DUBSOpenHub.github.io/My-AI-Readme/profiles/`
## 🤔 FAQ
**Q: How long does it take?**
A: About 3 minutes. Most questions are multiple-choice — just pick and go.
**Q: Do I need to be a good writer?**
A: Nope! You give short answers, the AI writes the polished version. You review and approve before saving.
**Q: I've never used Copilot CLI before.**
A: Perfect! Check out [ONBOARDING.md](ONBOARDING.md) — it'll get you from zero to running in under 2 minutes.
**Q: Can I update my profile later?**
A: Absolutely! Just run `@my-ai-readme` again and the agent will detect your existing profile and let you edit it.
**Q: What if I don't want to share certain info?**
A: Every field is optional. Skip anything you're not comfortable sharing.
## 🏗️ For Admins
Want to set this up for your company?
1. Fork this repo to your org
2. Share the ONBOARDING.md link with your team
3. Profiles accumulate in `profiles/` as people complete them
4. The directory at `profiles/README.md` auto-updates
## 📄 License
[MIT](LICENSE)
## 🤝 Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
---
## 🐙 Created with 💜 by [@DUBSOpenHub](https://github.com/DUBSOpenHub) with the [GitHub Copilot CLI](https://docs.github.com/copilot/concepts/agents/about-copilot-cli).
Let's build! 🚀✨