Skip to content

fix(readme): Update example GitHub repository URL #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 2, 2025
Merged

fix(readme): Update example GitHub repository URL #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ async function runDescription() {
console.log(`Markdown descriptions saved to ${markdownOptions.output}`);

// Scenario 3: Generate descriptions for a remote GitHub repository
const remoteRepoPath = 'https://github.com/IonGireada/repo-description.git';
const remoteRepoPath = 'https://github.com/ioncakephper/repo-description.git';
Copy link

@gemini-code-assist gemini-code-assist bot Nov 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For better readability and user experience, consider using the repository's web URL (without the .git suffix). The tool and git clone both handle this format correctly, and it provides a cleaner, browser-friendly link for users who might want to view the repository online.

Suggested change
const remoteRepoPath = 'https://github.com/ioncakephper/repo-description.git';
const remoteRepoPath = 'https://github.com/ioncakephper/repo-description';

const remoteOptions = {
cloneDir: './cloned_repos', // Directory to clone the remote repo into
format: 'json',
Expand All @@ -108,7 +108,7 @@ Use the `repo-describer` command directly in your terminal:
repo-describer . -o descriptions.json -f json

# Generate Markdown descriptions for a remote GitHub repository, clone it to a specific directory, and include a summary and table format
repo-describer https://github.com/IonGireada/repo-description.git -c ./cloned_repos -o repo-descriptions.md -f markdown --summary --table
repo-describer https://github.com/ioncakephper/repo-description.git -c ./cloned_repos -o repo-descriptions.md -f markdown --summary --table
Copy link

@gemini-code-assist gemini-code-assist bot Nov 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency and improved user experience, I recommend using the repository's web URL without the .git suffix here as well. This makes the URL easier to copy and paste into a browser for viewing.

Suggested change
repo-describer https://github.com/ioncakephper/repo-description.git -c ./cloned_repos -o repo-descriptions.md -f markdown --summary --table
repo-describer https://github.com/ioncakephper/repo-description -c ./cloned_repos -o repo-descriptions.md -f markdown --summary --table


# Generate descriptions for the current repository, ignoring specific patterns, and update a markdown-magic config file
repo-describer . -i "dist" "build" --update-config ./md.config.js --transform-name myDescriptions
Expand Down