andrevarandas/fetch-readme

Fetch a readme.md from a github repository.

Fetch Readme 📖

Fetch a raw readme.md from a public github repository.

Install

With Yarn

• yarn add @varandas/fetch-readme

With npm

• npm i --save @varandas/fetch-readme

Usage

// Usage for 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.

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

fetch-readme's Issues

An in-range update of @types/jest is breaking the build 🚨

---

☝️ Important announcement: Greenkeeper will be saying goodbye 👋 and passing the torch to Snyk on June 3rd, 2020! Find out how to migrate to Snyk and more at greenkeeper.io

---

The devDependency @types/jest was updated from 25.1.4 to 25.1.5.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/jest is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ Travis CI - Branch: The build errored.

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

An in-range update of ts-jest is breaking the build 🚨

---

☝️ Important announcement: Greenkeeper will be saying goodbye 👋 and passing the torch to Snyk on June 3rd, 2020! Find out how to migrate to Snyk and more at greenkeeper.io

---

The devDependency ts-jest was updated from 25.2.1 to 25.3.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

ts-jest is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ Travis CI - Branch: The build errored.

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

An in-range update of husky is breaking the build 🚨

---

☝️ Important announcement: Greenkeeper will be saying goodbye 👋 and passing the torch to Snyk on June 3rd, 2020! Find out how to migrate to Snyk and more at greenkeeper.io

---

The devDependency husky was updated from 4.2.3 to 4.2.4.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

husky is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ Travis CI - Branch: The build errored.

---

Release Notes for v4.2.4

• When Node version is unsupported, log actual version in addition to the error message #701
• Fix: support cnpm package manager #687
• Fix: always use sh to run scripts and avoid inconsistencies #707
• Fix: don't throw error if files are already removed during uninstall #708

Commits

The new version differs by 8 commits.

• 17c012d 4.2.4
• b1d4c32 Don't throw error during uninstall if file doesn't exist (#708)
• 4e1d440 fix: cnpm fails due to $packgeManager not matched (#687)
• 56c611d Fix usage of SHELL environment variable can cause unexpected behavior #683
• cbacd2e npm audit fix
• 8bb9911 Show runtime node version when exit (#701)
• 1bddecd Bump acorn from 5.7.3 to 5.7.4 (#688)
• 1f7d02d Update CHANGELOG.md

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

An in-range update of ts-node is breaking the build 🚨

---

☝️ Important announcement: Greenkeeper will be saying goodbye 👋 and passing the torch to Snyk on June 3rd, 2020! Find out how to migrate to Snyk and more at greenkeeper.io

---

The devDependency ts-node was updated from 8.7.0 to 8.8.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

ts-node is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ Travis CI - Branch: The build errored.

---

Release Notes for [Perf] List File Names

Added

• Add sanitize=true to README for SVGs to work on NPM

Fixed

• Simplify projectVersion++ by incrementing on each file change
• List all files for getScriptFileNames (#985) - revisits the change in #884

v8.7.0...v8.8.0

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

An in-range update of ts-jest is breaking the build 🚨

---

☝️ Important announcement: Greenkeeper will be saying goodbye 👋 and passing the torch to Snyk on June 3rd, 2020! Find out how to migrate to Snyk and more at greenkeeper.io

---

The devDependency ts-jest was updated from 25.3.0 to 25.3.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

ts-jest is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ Travis CI - Branch: The build errored.

---

Commits

The new version differs by 29 commits.

• 335ffd2 chore(release): 25.3.1
• a434ae5 chore: update package-lock.json
• 8079a45 build(deps-dev): bump jest from 25.2.6 to 25.2.7 (#1496)
• 54ba14d chore: fix program unit tests fail for local machine (#1495)
• 4f3b333 build(deps-dev): bump @types/react from 16.9.31 to 16.9.32 (#1493)
• ecdf1ab build(deps-dev): bump @types/jest from 25.1.4 to 25.1.5 (#1492)
• 628efcf chore: fix bug template not appearing (#1491)
• c1dc228 chore: add GitHub PR, issue templates (#1487)
• 330afe3 build(deps-dev): bump jest from 25.2.4 to 25.2.6 (#1489)
• ccc92ca build(deps-dev): bump @jest/transform from 25.2.4 to 25.2.6 (#1488)
• f8f8bf6 build(deps-dev): bump @jest/types from 25.2.3 to 25.2.6 (#1486)
• dbc0a08 fix: only do type checking while compiling file (#1483)
• 622fe4b Merge pull request #1484 from kulshekhar/dependabot/npm_and_yarn/tslint-6.1.1
• 8549826 build(deps-dev): bump tslint from 6.1.0 to 6.1.1
• 1a2c907 build(deps-dev): bump @types/react from 16.9.30 to 16.9.31 (#1481)

There are 29 commits in total.

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

An in-range update of @types/jest is breaking the build 🚨

---

☝️ Important announcement: Greenkeeper will be saying goodbye 👋 and passing the torch to Snyk on June 3rd, 2020! Find out how to migrate to Snyk and more at greenkeeper.io

---

The devDependency @types/jest was updated from 25.1.3 to 25.1.4.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/jest is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build could not complete due to an error (Details).
• ❌ Travis CI - Branch: The build errored.

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

An in-range update of ts-node is breaking the build 🚨

---

☝️ Important announcement: Greenkeeper will be saying goodbye 👋 and passing the torch to Snyk on June 3rd, 2020! Find out how to migrate to Snyk and more at greenkeeper.io

---

The devDependency ts-node was updated from 8.6.2 to 8.7.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

ts-node is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build could not complete due to an error (Details).
• ❌ Travis CI - Branch: The build errored.

---

Release Notes for v8.7.0

Fixed

• Remove buggy caching of ts.sys.readDirectory (#969)
• Fix REPL ASI handling when user input starts with - (#944)

Added

• Implement LanguageServiceHost::getProjectVersion to workaround microsoft/TypeScript#36748 (#906
• Add ts-node-transpile-only binary (#939) @G-Rath

Changed

• Deprecate ts-script in favor of ts-node-script (#948) @G-Rath

Docs

• Fix bash syntax error in README (#943) @abraj
• Add Github issue templates (#959, #965, #947)
• Add IntelliJ debug instructions to README (#958)
• Add mocha 7 usage example to README (#961)

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

An in-range update of @types/jest is breaking the build 🚨

The devDependency @types/jest was updated from 24.0.1 to 24.0.2.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/jest is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build failed (Details).
• ❌ Travis CI - Branch: The build failed.

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

An in-range update of semantic-release is breaking the build 🚨

---

☝️ Important announcement: Greenkeeper will be saying goodbye 👋 and passing the torch to Snyk on June 3rd, 2020! Find out how to migrate to Snyk and more at greenkeeper.io

---

The devDependency semantic-release was updated from 17.0.4 to 17.0.5.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

semantic-release is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ Travis CI - Branch: The build errored.

---

Release Notes for v17.0.5

17.0.5 (2020-04-16)

Bug Fixes

• adapt for semver to version 7.3.2 (0363790)

Commits

The new version differs by 11 commits.

• 0363790 fix: adapt for semver to version 7.3.2
• 93cb766 chore(package): update semver to version 7.3.2
• caa3526 style: xo
• ed5f26d chore(package): update xo to version 0.29.0
• ff1d53d docs: add @google/semantic-release-replace-plugin to plugin list (#1509)
• f899fa9 chore(package): update xo to version 0.28.1
• b5488ae chore(package): update fs-extra to version 9.0.0
• da5d1cf chore(package): update tempy to version 0.5.0
• da5d06c docs: fix formatting for GitBook
• b85adbd chore(package): update xo to version 0.27.0
• bce633a chore(package): update sinon to version 9.0.0

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Look for all variations of readme.

Just a suggestion. Can the package look for variations of readme if README.md is not found?
I have seen people having readme files like Readme.md, readme.md etc.
Github seems to parse it correctly in the repo page.

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two-Factor Authentication, make configure the auth-only level is supported. semantic-release cannot publish with the default auth-and-writes level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀

An in-range update of ts-node is breaking the build 🚨

---

☝️ Important announcement: Greenkeeper will be saying goodbye 👋 and passing the torch to Snyk on June 3rd, 2020! Find out how to migrate to Snyk and more at greenkeeper.io

---

The devDependency ts-node was updated from 8.8.1 to 8.8.2.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

ts-node is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ Travis CI - Branch: The build errored.

---

Release Notes for Avoid Extra `rootFileNames` Changes

Fixed

• Avoid pushing to rootFileNames with version

Commits

The new version differs by 3 commits.

• 3f50313 8.8.2
• 92cf961 Avoid pushing to rootFileNames with version
• 366ac0b Add test covering --files flag (#987)

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

An in-range update of ts-jest is breaking the build 🚨

---

🚨 Reminder! Less than one month left to migrate your repositories over to Snyk before Greenkeeper says goodbye on June 3rd! 💜 🚚💨 💚

Find out how to migrate to Snyk at greenkeeper.io

---

The devDependency ts-jest was updated from 25.5.0 to 25.5.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

ts-jest is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ Travis CI - Branch: The build errored.

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴