feat(project): Initial commit

adds library files

Author: AndreVarandas

.gitignore

@@ -0,0 +1,71 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next
+
+# Library folder
+lib
+
+# OSX
+.DS_Store
+
+# Editors
+.idea
+.vscode

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "printWidth": 80,
+  "trailingComma": "es5",
+  "singleQuote": true,
+  "semi": false
+}

.travis.yml

@@ -0,0 +1,20 @@
+sudo: false
+language: node_js
+branches:
+  only:
+    - master
+notifications:
+  email: false
+node_js:
+  - '10'
+script:
+  - yarn lint
+  - yarn global add codecov -g
+  - yarn test
+  - codecov -f coverage/*.json
+after_success:
+  - codecov
+  - yarn semantic-release
+branches:
+  except:
+    - "/^v\\d+\\.\\d+\\.\\d+$/"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 André Varandas
+
+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.

README.md

@@ -0,0 +1,58 @@
+# Fetch Readme 📖
+
+Fetch a raw readme.md from a public github repository.
+
+[![Build Status](https://travis-ci.org/AndreVarandas/fetch-readme.svg?branch=master)](https://travis-ci.org/AndreVarandas/fetch-readme)
+[![Codecov Coverage](https://img.shields.io/codecov/c/github/AndreVarandas/fetch-readme/master.svg?style=flat-square)](https://codecov.io/gh/AndreVarandas/fetch-readme/)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+![](https://badges.greenkeeper.io/andrevarandas/fetch-readme.svg?style=flat)
+
+### Install
+
+- `yarn add @varandas/fetch-readme`
+
+OR
+
+- `npm i --save @varandas/fetch-readme` 
+
+### Usage
+
+```javascript
+// Commonjs
+const { fetchReadme } = require('@varandas/fetch-readme');
+
+fetchReadme({
+    username: 'Microsoft',
+    repository: 'TypeScript'
+})
+    .then(readme => console.log(readme));
+
+// OR ES2015
+import { fetchReadme } from '@varandas/fetch-readme'
+
+(async () => {
+    const readme = await fetchReadme({
+        username: 'Microsoft',
+        repository: 'TypeScript'
+    })
+    console.log(readme)  
+})()
+```
+
+### Configuration Options
+
+Both username and repository properties are required.
+`branch` defaults to `master` and `readme` to `README.md`.
+
+```javascript
+const config = {
+    username: 'andrevarandas',
+    repository: 'the-repository-name',
+    branch: 'develop',
+    readme: 'readme.md'
+}
+```
+
+**Note** The readme file name is case sensitive.
+
+[LICENSE - MIT - André Varandas](LICENSE)

jestconfig.json

@@ -0,0 +1,8 @@
+{
+  "transform": {
+    "^.+\\.(t|j)sx?$": "ts-jest"
+  },
+  "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
+  "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"],
+  "collectCoverage":true
+}