https://github.com/kelysty/npm-template

This is a template repo for creating npm packages
https://github.com/kelysty/npm-template

npm template

Last synced: 8 days ago
JSON representation

This is a template repo for creating npm packages

• Host: GitHub
• URL: https://github.com/kelysty/npm-template
• Owner: Kelysty
• License: mit
• Created: 2023-11-27T07:29:18.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-30T09:37:28.000Z (about 1 year ago)
• Last Synced: 2024-11-18T14:38:52.382Z (2 months ago)
• Topics: npm, template
• Language: TypeScript
• Homepage:
• Size: 371 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @kelysty/npm-template · [![npm package](https://img.shields.io/npm/v/@kelysty/npm-template)](https://www.npmjs.com/package/@kelysty/npm-template) [![CI](https://img.shields.io/github/actions/workflow/status/Kelysty/npm-template/.github%2Fworkflows%2Fci.yml?logo=github&label=CI)](https://github.com/kelysty/npm-template/actions/workflows/ci.yml?query=branch:main) [![storybook](https://img.shields.io/badge/Storybook-deployed-ff4685)](https://preview.kelysty.com/npm-template/)

This is a template for a typical `npm package`

1. Create a new repository and use this repository as a template

2. Replace `npm-template` throughout the repository with your name

3. Overwrite other things at your desire

## Install

Using `npm`:

```bash

npm install --save-dev @kelysty/npm-template

```

Using `yarn`:

```bash

yarn add --dev @kelysty/npm-template

```

## Usage

Put usage instructions here