# @iyowei/is-readme-path

> 异步获取指定 Git 项目远程仓库地址。

Latest version **1.0.1** (published 2021-12-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install @iyowei/is-readme-path
pnpm add @iyowei/is-readme-path
yarn add @iyowei/is-readme-path
bun add @iyowei/is-readme-path
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-12-18 |
| First published | 2021-12-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=12.20.0 |
| Dependencies | 0 |
| Unpacked size | 2.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | itonyyo |
| Keywords | iyowei |

## Links

- npm: https://www.npmjs.com/package/@iyowei/is-readme-path
- Repository: https://github.com/iyowei/is-readme-path
- Homepage: https://github.com/iyowei/is-readme-path#readme
- Issues: https://github.com/iyowei/is-readme-path/issues
- npm.io page: https://npm.io/package/@iyowei/is-readme-path

## Recent versions

- 1.0.1 (latest) — 2021-12-18
- 1.0.0 — 2021-12-14

## README

# isReadmePath(path)

> 判定给定路径是否指向一个 README.md。

## 使用

- path {String} 路径，**默认：** `""`；
- 返回 {Boolean} 指向 README.md 为 `true`，否则 `false`。

```js
import {log} from 'console';
import isReadmePath from '@iyowei/is-readme-path';

log(isReadmePath('isReadmePath("~/README.md"))')); // true

```

## 安装

[![Node version](https://img.shields.io/badge/node.js-%3E%3D12.20.0-brightgreen?style=flat&logo=Node.js)](https://nodejs.org/en/download/)

```shell
# Pnpm
pnpm add @iyowei/is-readme-path

# yarn
yarn add @iyowei/is-readme-path

# npm
npm add @iyowei/is-readme-path
```

## 参与贡献
![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)

---
_Source: https://npm.io/package/@iyowei/is-readme-path · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
