https://github.com/iyowei/is-readme-path

判定给定路径是否指向一个 README.md。
https://github.com/iyowei/is-readme-path

iyowei nodejs path readme utilities

Last synced: about 7 hours ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/iyowei/is-readme-path
• Owner: iyowei
• License: mit
• Created: 2021-12-14T04:20:08.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-18T07:40:12.000Z (almost 3 years ago)
• Last Synced: 2024-04-24T13:55:10.239Z (7 months ago)
• Topics: iyowei, nodejs, path, readme, utilities
• Language: JavaScript
• Homepage:
• Size: 4.88 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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)