https://github.com/chanonroy/is-chanon

🤔 Parody npm package to test tooling, publishing, and deployment
https://github.com/chanonroy/is-chanon

circleci docz jest netlify node semantic-release typescript yarn

Last synced: 5 months ago
JSON representation

🤔 Parody npm package to test tooling, publishing, and deployment

• Host: GitHub
• URL: https://github.com/chanonroy/is-chanon
• Owner: chanonroy
• License: mit
• Created: 2019-04-15T14:29:26.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T04:43:09.000Z (over 2 years ago)
• Last Synced: 2024-12-06T21:04:03.092Z (5 months ago)
• Topics: circleci, docz, jest, netlify, node, semantic-release, typescript, yarn
• Language: TypeScript
• Homepage: https://is-chanon.netlify.com/
• Size: 1.76 MB
• Stars: 11
• Watchers: 3
• Forks: 0
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# is-chanon

[![NPM](https://img.shields.io/npm/l/is-chanon.svg)](https://github.com/chanonroy/is-chanon/blob/master/LICENSE)

[![npm](https://img.shields.io/npm/v/is-chanon.svg)](https://www.npmjs.com/package/is-chanon)

[![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)

A simple stateless function to determine whether a string contains my name (Chanon) or not.

This is more of a parody module to help me test out best practices with CI/CD, npm publishing, and semantic versioning.

## Usage

Install the package

```

yarn add is-chanon

```

Use the package as needed

```js

const isChanon = require("is-chanon");

isChanon("Chanon"); // true

isChanon("chanon"); // true

isChanon("Charles"); // false

isChanon("channon"); // false

isChanon("matthew"); // false

```

## Testing

Install dependencies

```

yarn

```

Run the Jest tests

```

yarn test

```

## Contributing

Feel free to open up a PR and contribute to this great npm package.