Credits and usage
How many credits do I get when I sign up?
How many credits do I get when I sign up?
New users receive 1 free credit when they create an account. This allows you to generate your first README and try out the service.
How much does each README generation cost?
How much does each README generation cost?
Each README generation consumes 1 credit from your account balance. Your credits are deducted only after a successful generation.
What happens if I run out of credits?
What happens if I run out of credits?
When your credit balance reaches 0, you’ll need to purchase additional credits to continue generating READMEs. You can purchase credits directly from the application using Stripe.
How much do additional credits cost?
How much do additional credits cost?
Credits are priced at $1.25 per credit. You can purchase credits in bundles through the secure Stripe checkout process.
Are my credits refundable?
Are my credits refundable?
Please refer to our refund policy page for detailed information about credit refunds and payment policies.
Repository requirements
What type of repositories can I use?
What type of repositories can I use?
GitRead works with public GitHub repositories. The repository URL must be in the format:
https://github.com/username/repositoryCan I use private repositories?
Can I use private repositories?
No, GitRead currently only supports public GitHub repositories. Private repositories cannot be accessed by the generation service.
Are there size limits for repositories?
Are there size limits for repositories?
Yes, repositories have the following limits:
- Maximum token limit: 900,000 tokens
- Maximum file size varies based on repository structure
- Maximum total size and file count limits apply
How long does README generation take?
How long does README generation take?
Generation time varies based on repository size and current server load. Small to medium repositories typically take 30-60 seconds. Larger repositories may take several minutes.
Features and functionality
Can I edit the generated README?
Can I edit the generated README?
Yes, GitRead includes an interactive editor that lets you modify the generated markdown directly in your browser. You can switch between markdown view and preview mode.
How do I save or download my README?
How do I save or download my README?
You can:
- Copy the markdown to your clipboard using the Copy button
- Download it as a
.mdfile - View it in your README history if you’re signed in
Where can I find my previously generated READMEs?
Where can I find my previously generated READMEs?
All authenticated users have access to their README history. Your generated READMEs are automatically saved and can be accessed from your history panel.
What AI model powers GitRead?
What AI model powers GitRead?
GitRead uses Google’s Gemini model (specifically gemini-2.5-pro-preview-03-25) via the OpenRouter API to generate high-quality, comprehensive README files.
Can I use example repositories to test?
Can I use example repositories to test?
Yes, GitRead provides pre-selected example repositories that you can use to quickly test the functionality without entering your own repository URL.
Account and authentication
Do I need an account to use GitRead?
Do I need an account to use GitRead?
Yes, authentication is required to generate README files. GitRead uses Clerk for secure sign-in and sign-up.
How is my data stored?
How is my data stored?
User credits and README history are stored securely in a Supabase PostgreSQL database with Row Level Security (RLS) policies to protect your data.
Can I use GitRead on different domains?
Can I use GitRead on different domains?
Yes, GitRead supports multiple domains (such as
gitread.com and generatemyreadme.com) that redirect to the primary service at gitread.dev.