https://github.com/imranbarbhuiya/package-template

https://github.com/imranbarbhuiya/package-template

Last synced: about 5 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/imranbarbhuiya/package-template
• Owner: imranbarbhuiya
• License: mit
• Created: 2022-03-20T03:45:30.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-17T06:16:58.000Z (about 2 months ago)
• Last Synced: 2024-09-17T11:31:57.833Z (about 2 months ago)
• Language: TypeScript
• Size: 12 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        


# @imranbarbhuiya/package-template

**Template for Parbez's Repositories.**

[![GitHub](https://img.shields.io/github/license/imranbarbhuiya/package-template)](https://github.com/imranbarbhuiya/package-template/blob/main/LICENSE)

[![codecov](https://codecov.io/gh/imranbarbhuiya/package-template/branch/main/graph/badge.svg?token=token)](https://codecov.io/gh/imranbarbhuiya/package-template)

[![npm](https://img.shields.io/npm/v/@imranbarbhuiya/package-template?color=crimson&logo=npm&style=flat-square)](https://www.npmjs.com/package/@imranbarbhuiya/package-template)



## Steps after creating a repo with this template

1. Find and replace all instances of `template` with the package name.

2. remove `true ||` from workflows

3. Ensure branch protection is on

4. Enable Codecov for the repository

5. Add `CODECOV_TOKEN` and `NPM_PUBLISH_TOKEN` to the repository secrets

6. Remove this section from the README

## Description

A description of the package.

Read Full Documentation [here](https://template.js.org/).

## Features

-   Written In Typescript

-   Offers CJS, ESM and UMD builds

-   Full TypeScript & JavaScript support

## Install

You can use the following command to install this package, or replace npm install with your package manager of choice.

```bash

npm i @imranbarbhuiya/package-template

```

## Usage

```ts

import { fn } from 'template';

```

### Some contents goes here

## Buy me some doughnuts

If you want to support me by donating, you can do so by using any of the following methods. Thank you very much in advance!







## Contributors ✨

Thanks goes to these wonderful people: