feat: add API docs

.eslintrc.js

@@ -3,6 +3,7 @@ module.exports = {
   env: {
     node: true
   },
+  plugins: ['@typescript-eslint/eslint-plugin', 'eslint-plugin-tsdoc'],
   ignorePatterns: ['dist/**', 'coverage/**'],
   extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'],
   parserOptions: {

.github/workflows/release.yml

@@ -21,15 +21,13 @@ jobs:
         if: ${{ steps.release.outputs.release_created }}
       - run: yarn install --frozen-lockfile
         if: ${{ steps.release.outputs.release_created }}
-      - run: yarn docs
+      - run: yarn release
         if: ${{ steps.release.outputs.release_created }}
       - uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./docs/.vitepress/dist
         if: ${{ steps.release.outputs.release_created }}
-      - run: yarn build
-        if: ${{ steps.release.outputs.release_created }}
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -2,3 +2,6 @@ node_modules
 dist
 coverage
 .idea
+docs/api
+etc
+temp

README.md

@@ -1,8 +1,7 @@
 [![Codecov](https://codecov.io/gh/dm4t2/intl-number-input/branch/master/graph/badge.svg)](https://codecov.io/gh/dm4t2/intl-number-input)
-[![npm Version](https://badgen.net/npm/v/intl-number-input?color=green)](https://www.npmjs.com/package/intl-number-input)
-[![npm Downloads](https://badgen.net/npm/dw/intl-number-input?color=green)](https://www.npmjs.com/package/intl-number-input)
-[![Bundlephobia](https://badgen.net/bundlephobia/minzip/intl-number-input?color=green)](https://bundlephobia.com/result?p=intl-number-input)
-[![License](https://badgen.net/github/license/dm4t2/intl-number-input?color=green)](https://github.com/dm4t2/intl-number-input/blob/master/LICENSE)
+![npm](https://img.shields.io/npm/v/intl-number-input)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/intl-number-input)
+![NPM](https://img.shields.io/npm/l/intl-number-input)
 
 # Intl Number Input
 
@@ -11,3 +10,9 @@ Intl Number Input allows an easy input of formatted numbers based on the [ECMASc
 ## Getting started
 
 Please read the [guide](https://dm4t2.github.io/intl-number-input/guide) to get started or check out the [playground](https://dm4t2.github.io/intl-number-input/playground) to see it in action.
+
+## Support me
+
+If you find my work helpful, or you want to support the development, star the repo or buy me a coffee:
+
+[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D6SXEA)