search

posener / goreadme

Generate readme file from Go doc. Now available as a Github action!
MIT License
213 stars 31 forks source link

Badge Path of `.` #93

Open fosskers opened 3 years ago

fosskers commented 3 years ago

Hi there, thanks for a nice tool. I'm running it with:

goreadme --skip-examples --badge-godoc --badge-goreportcard

directly from the project, and I notice that even though the project name is detected correctly and displayed as the top-level markdown heading, it's not respected in the badge URLs:

[![GoDoc](https://img.shields.io/badge/pkg.go.dev-doc-blue)](http://pkg.go.dev/.)
[![Go Report Card](https://goreportcard.com/badge/.)](https://goreportcard.com/report/.)
posener commented 3 years ago

Right. Maybe there could be a more elegant solution for this, but you can currently use the import-path command line flag.