At README AI, we take your privacy seriously. This Privacy Policy explains how we collect, use, and protect your information when you use our web application and browser extension.
Information We Collect
GitHub Account Information
When you authenticate with GitHub, we receive and store:
- Your GitHub username and profile information
- Your public repositories list
- Repository metadata (name, description, language, etc.)
- Access tokens for API interactions (securely encrypted)
Generated Content
We store the README files you generate to provide history and improve our service:
- Generated README content
- Repository information for which READMEs were created
- Generation timestamps and preferences
Browser Extension Data
Our Chrome extension stores minimal data locally:
- Authentication tokens (stored securely in browser storage)
- Your repository list for quick access
- Extension preferences and settings
How We Use Your Information
We use your information to:
- Generate README files: Analyze your repositories to create relevant documentation
- Provide authentication: Securely connect to your GitHub account
- Store your history: Keep track of previously generated READMEs
- Improve our service: Understand usage patterns to enhance functionality
- Provide support: Help resolve any issues you may encounter
Data Security
We implement industry-standard security measures to protect your data:
- Encryption: All data is encrypted in transit and at rest
- Secure storage: Authentication tokens are stored using secure browser APIs
- Limited access: We only request minimal GitHub permissions needed for functionality
- Regular security audits: Our systems undergo regular security reviews
Data Sharing and Third Parties
We do not sell, trade, or share your personal information with third parties, except:
- GitHub API: We communicate with GitHub's API to access your repositories
- AI Services: Repository analysis may use AI services to generate content (no personal data is shared)
- Legal requirements: If required by law or to protect our rights
Browser Extension Specific Practices
Our Chrome extension follows strict privacy practices:
- Local storage only: Sensitive data stays in your browser
- Minimal permissions: We only request necessary browser permissions
- No tracking: We don't track your browsing activity outside of GitHub
- Secure communication: All communication with our servers uses HTTPS
Your Rights and Control
You have the right to:
- Access your data: View all data we have stored about you
- Delete your data: Request complete deletion of your account and data
- Update information: Modify or correct any stored information
- Revoke access: Disconnect your GitHub account at any time
- Export data: Download your generated READMEs and history
To exercise these rights, contact us at Github
Cookies and Local Storage
We use minimal cookies and local storage for:
- Maintaining your login session
- Storing user preferences
- Caching repository data for better performance
You can clear this data through your browser settings at any time.
Data Retention
We retain your data for as long as your account is active. When you delete your account:
- All personal data is permanently deleted within 30 days
- Generated content may be retained in anonymized form for service improvement
- Access tokens are immediately revoked and deleted
Children's Privacy
Our service is not intended for children under 13. We do not knowingly collect personal information from children under 13. If we become aware that we have collected such information, we will take steps to delete it immediately.
Changes to This Policy
We may update this Privacy Policy from time to time. We will notify you of any material changes by:
- Posting the new policy on this page
- Updating the "Last updated" date
- Sending you an email notification (if you have an account)
Contact Us
If you have any questions about this Privacy Policy or our practices, please contact us: