Я не вижу, как можно вставить кнопку в свой файл Readme.md репозитория Github, связывая, в данном случае, пакет библиотеки Dart.
Например, глядя на файл Github README.md, Плагины Flutter , внизу страницы вы увидите список кнопок со ссылками на соответствующие им страницы пакетов pub.dartlang.org: 