lib/Github/Api/Repo.php
public function readme($username, $repository, $format = 'raw')
    {
        return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/readme', [], [
            'Accept' => "application/vnd.github.$format",
        ]);
    }
public function readme($username, $repository, $format = 'raw')
    {
        return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/readme', [], [
            'Accept' => "application/vnd.github.$format",
        ]);
    }
public function readme ( $ username , $ repository , $ format = 'raw' ) { return $ this -> get ( '/repos/' . rawurlencode ( $ username ) . '/' . rawurlencode ( $ repository ) . '/readme' , [ ] , [ 'Accept' => "application/vnd.github.$format" , ] ) ; }
Get the readme content for a repository by its username and repository name.

@link http://developer.github.com/v3/repos/contents/#get-the-readme

@param string $username   the user who owns the repository
@param string $repository the name of the repository
@param string $format     one of formats: "raw", "html", or "v3+json"

@return string|array the readme content
Get the readme content for a repository by its username and repository name .