-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
87ce133
commit 7d8d4f5
Showing
1 changed file
with
2 additions
and
85 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,86 +1,3 @@ | ||
| <p align="center"> | ||
| <img width="100px" src="https://raw.githubusercontent.com/hebertcisco/ts-npm-package-boilerplate/main/.github/images/favicon512x512-npm.png" align="center" alt=":package: ts-npm-package-boilerplate" /> | ||
| <h2 align="center">:package: ts-npm-package-boilerplate</h2> | ||
| <p align="center">TypeScript NPM Module Boilerplate</p> | ||
| <p align="center"> | ||
| <a href="https://github.com/hebertcisco/ts-npm-package-boilerplate/issues"> | ||
| <img alt="Issues" src="https://img.shields.io/github/issues/hebertcisco/ts-npm-package-boilerplate?style=flat&color=336791" /> | ||
| </a> | ||
| <a href="https://github.com/hebertcisco/ts-npm-package-boilerplate/pulls"> | ||
| <img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/hebertcisco/ts-npm-package-boilerplate?style=flat&color=336791" /> | ||
| </a> | ||
| <a href="https://github.com/hebertcisco/ts-npm-package-boilerplate"> | ||
| <img alt="GitHub Downloads" src="https://img.shields.io/npm/dw/ts-npm-package-boilerplate?style=flat&color=336791" /> | ||
| </a> | ||
| <a href="https://github.com/hebertcisco/ts-npm-package-boilerplate"> | ||
| <img alt="GitHub Total Downloads" src="https://img.shields.io/npm/dt/ts-npm-package-boilerplate?color=336791&label=Total%20downloads" /> | ||
| </a> | ||
| <a href="https://github.com/hebertcisco/ts-npm-package-boilerplate"> | ||
| <img alt="GitHub release" src="https://img.shields.io/github/release/hebertcisco/ts-npm-package-boilerplate.svg?style=flat&color=336791" /> | ||
| </a> | ||
| <br /> | ||
| <br /> | ||
| <a href="https://github.com/hebertcisco/ts-npm-package-boilerplate/issues/new/choose">Report Bug</a> | ||
| <a href="https://github.com/hebertcisco/ts-npm-package-boilerplate/issues/new/choose">Request Feature</a> | ||
| </p> | ||
| <h3 align="center">Systems on which it has been tested:</h3> | ||
| <p align="center"> | ||
| <a href="https://www.apple.com/br/macos/"> | ||
| <img alt="Macos" src="https://img.shields.io/badge/mac%20os-000000?style=for-the-badge&logo=apple&logoColor=white&style=flat" /> | ||
| </a> | ||
| <a href="https://ubuntu.com/download"> | ||
| <img alt="Ubuntu" src="https://img.shields.io/badge/Ubuntu-E95420?style=for-the-badge&logo=ubuntu&logoColor=white&style=flat" /> | ||
| </a> | ||
| <a href="https://www.microsoft.com/pt-br/windows/"> | ||
| <img alt="Windows" src="https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white&style=flat" /> | ||
| </a> | ||
| </p> | ||
| <p align="center">Did you like the project? Please, considerate <a href="https://www.buymeacoffee.com/hebertcisco">a donation</a> to help improve!</p> | ||
| Will fill this out later. | ||
|
|
||
| <p align="center"><strong>TypeScript NPM Module Boilerplate</strong>✨</p> | ||
|
|
||
| [](https://codecov.io/gh/hebertcisco/ts-npm-package-boilerplate) | ||
|
|
||
| # Getting started | ||
|
|
||
| ## Installation | ||
|
|
||
| > Clone this repository: `git clone https://github.com/hebertcisco/ts-npm-package-boilerplate` | ||
| ### Open the directory and run the script line: | ||
|
|
||
| ```bash | ||
| cd ts-npm-package-boilerplate | ||
| ``` | ||
| ```bash | ||
| npm i # or yarn | ||
| ``` | ||
| ```bash | ||
| rm -rf .git && git init && git add . && git commit -m "Initial commit" #Optional | ||
| ``` | ||
| Or create use the button "Use this template" | ||
|
|
||
| Edit the Icon on Figma: | ||
|
|
||
| <a href="https://www.figma.com/file/vpevGX3j9tmtW8OyLQ9eUm/ts-npm-package-boilerplate-icon?node-id=0%3A1"> | ||
| <img alt="Figma Icon" src="https://raw.githubusercontent.com/hebertcisco/ts-npm-package-boilerplate/main/.github/images/figma-badge.png"/> | ||
| </a> | ||
|
|
||
| ## 🤝 Contributing | ||
|
|
||
| Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](issues). | ||
|
|
||
| ## Show your support | ||
|
|
||
| Give a ⭐️ if this project helped you! | ||
|
|
||
| Or buy me a coffee 🙌🏾 | ||
|
|
||
| <a href="https://www.buymeacoffee.com/hebertcisco"> | ||
| <img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=hebertcisco&button_colour=FFDD00&font_colour=000000&font_family=Inter&outline_colour=000000&coffee_colour=ffffff" /> | ||
| </a> | ||
|
|
||
| ## 📝 License | ||
|
|
||
| Copyright © 2022 [Hebert F Barros](https://github.com/hebertcisco).<br /> | ||
| This project is [MIT](LICENSE) licensed. | ||
| Read: https://medium.com/@evkirkiles/coloring-the-webkit-browser-bars-28d75cd8cf7f |