Bolt\Composer\PackageManager::linkReadMe PHP Method

linkReadMe() private method

Return the URI for a package's readme.
private linkReadMe ( Bolt\Extension\ResolvedExtension $extension ) : string
$extension Bolt\Extension\ResolvedExtension
return string
    private function linkReadMe(ResolvedExtension $extension)
    {
        $readme = null;
        $filesystem = $this->app['filesystem']->getFilesystem('extensions');
        if ($filesystem->has(sprintf('%s/README.md', $extension->getRelativePath()))) {
            $readme = $extension->getRelativePath() . '/README.md';
        } elseif ($filesystem->has(sprintf('%s/readme.md', $extension->getRelativePath()))) {
            $readme = $extension->getRelativePath() . '/readme.md';
        }
        if (!$readme) {
            return;
        }
        return $this->app['url_generator']->generate('readme', ['filename' => $readme]);
    }