rawgithub

Get raw files from github repos

Usage no npm install needed!

<script type="module">
  import rawgithub from 'https://cdn.skypack.dev/rawgithub';
</script>

README

rawgithub NPM version Build Status

Information

Package rawgithub
Description Get raw files from github repos
Node Version >= 0.10

Install

npm install rawgithub --save

Example


var rawgithub = require('rawgithub');

var url = 'https://github.com/stevelacy/rawgithub/blob/master/README.md';
rawgithub(url, function(err, data){
  // => returns the file contents as a string
});


Options

Type: object

Defaults:

base: 'https://raw.githubusercontent.com'
host: 'github.com'

LICENSE

(MIT License)

Copyright (c) 2014 Steve Lacy me@slacy.me

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.