Privacy Policy
Last updated: March 2, 2026
Welcome to ReadmeGen. We respect your privacy and are committed to protecting your personal data. This privacy policy will inform you as to how we look after your personal data when you visit our website and tell you about your privacy rights and how the law protects you.
data_usage 1. Information We Collect
ReadmeGen is designed to be a client-side tool. We do not require you to create an account or provide any mandatory personal information to use the basic features of the service.
However, when you use our editor, you may voluntarily input:
- GitHub Username: To fetch public repository statistics and profile data.
- Social Links: URLs or handles for platforms like LinkedIn, Twitter, Instagram, etc.
- Biographical Text: Any text you choose to include in your generated README.
Important: The information you enter into the editor is processed directly in your browser. We do not transmit, save, or harvest this data on our servers. The final markdown is generated locally.
cookie 2. Cookies and Local Storage
We use browser Local Storage to save your editor progress across sessions. This ensures that if you accidentally close your tab or return later, your previously entered data and selected templates are preserved. This data never leaves your device and is not accessible by us.
api 3. Third-Party Services
To provide dynamic content such as stats cards and visitor badges, we utilize third-party APIs embedded within the generated markdown:
- Vercel (GitHub Readme Stats): Used to render your GitHub stats based on your public username.
- Heroku (Streak Stats): Used to calculate and display your contribution streak.
- Komarev (Visitor Badge): Used to track profile views.
These services observe standard web requests when anyone views your generated README on GitHub. They do not have access to any data you enter into our editor beyond what is explicitly placed in the markdown URLs. Please refer to their respective privacy policies for more information.
security 4. Data Security
Since we do not store your personal input data on our servers, the risk of data breach from our systems is practically non-existent. We ensure our hosting environment (Vercel) follows industry-standard security practices for delivering the client application to you.
child_care 5. Children's Privacy
Our service is not intended for children under 13 years of age. We do not knowingly collect personal information from children under 13.
update 6. Changes to this Policy
We may update our Privacy Policy from time to time. We will notify you of any changes by posting the new Privacy Policy on this page. You are advised to review this Privacy Policy periodically for any changes.
mail 7. Contact Us
If you have any questions about this Privacy Policy, please contact us via our GitHub repository issues page.