Skip to content

Commit 88bffba

Browse files
committed
chore: readme improve
1 parent b498c37 commit 88bffba

File tree

4 files changed

+49
-23
lines changed

4 files changed

+49
-23
lines changed

.github/art/cover.jpg

24.7 KB
Loading

README.md

Lines changed: 48 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,39 +8,61 @@
88

99
# ts-inputs
1010

11-
This is an opinionated TypeScript Starter kit to help kick-start development of your next Bun package.
11+
A collection of smart, type-safe input components for Vue.js that provides automatic formatting, validation, and internationalization support. Built to make form input handling both powerful and developer-friendly.
1212

1313
## Features
1414

15-
This Starter Kit comes pre-configured with the following:
15+
ts-inputs comes with the following powerful features:
1616

17-
- 🛠️ [Powerful Build Process](https://github.com/oven-sh/bun) - via Bun
18-
- 💪🏽 [Fully Typed APIs](https://www.typescriptlang.org/) - via TypeScript
19-
- 📚 [Documentation-ready](https://vitepress.dev/) - via VitePress
20-
-[CLI & Binary](https://www.npmjs.com/package/bunx) - via Bun & CAC
21-
- 🧪 [Built With Testing In Mind](https://bun.sh/docs/cli/test) - pre-configured unit-testing powered by [Bun](https://bun.sh/docs/cli/test)
22-
- 🤖 [Renovate](https://renovatebot.com/) - optimized & automated PR dependency updates
23-
- 🎨 [ESLint](https://eslint.org/) - for code linting _(and formatting)_
24-
- 📦️ [pkg.pr.new](https://pkg.pr.new) - Continuous (Preview) Releases for your libraries
25-
- 🐙 [GitHub Actions](https://github.com/features/actions) - runs your CI _(fixes code style issues, tags releases & creates its changelogs, runs the test suite, etc.)_
17+
- 🎯 **Smart Input Components**
18+
- Credit Card formatting with automatic card type detection
19+
- Date formatting with customizable patterns
20+
- Time formatting with 12h/24h support
21+
- Numerical formatting with thousand/lakh grouping
22+
- Google Places autocomplete integration
2623

27-
## Get Started
24+
- 💪 **Type Safety**
25+
- Full TypeScript support
26+
- Type-safe props and events
27+
- Intelligent autocompletion
28+
29+
- 🌈 **Developer Experience**
30+
- Simple Vue.js integration
31+
- Customizable formatting options
32+
- Automatic validation
33+
- Internationalization support
34+
- Modern and clean UI
2835

29-
It's rather simple to get your package development started:
36+
## Get Started
3037

3138
```bash
32-
# you may use this GitHub template or the following command:
33-
bunx degit stacksjs/ts-inputs my-pkg
34-
cd my-pkg
39+
# Install using your preferred package manager
40+
npm install ts-inputs
41+
# or
42+
yarn add ts-inputs
43+
# or
44+
pnpm add ts-inputs
45+
```
3546

36-
bun i # install all deps
37-
bun run build # builds the library for production-ready use
47+
Basic usage example:
3848

39-
# after you have successfully committed, you may create a "release"
40-
bun run release # automates git commits, versioning, and changelog generations
41-
```
49+
```vue
50+
<script setup lang="ts">
51+
import { CreditCardInput, DateInput, NumeralInput, TimeInput } from 'ts-inputs'
4252
43-
_Check out the package.json scripts for more commands._
53+
const cardNumber = ref('')
54+
const date = ref('')
55+
const time = ref('')
56+
const number = ref('')
57+
</script>
58+
59+
<template>
60+
<CreditCardInput v-model="cardNumber" placeholder="Enter card number" />
61+
<DateInput v-model="date" pattern="YYYY-MM-DD" />
62+
<TimeInput v-model="time" format="24h" />
63+
<NumeralInput v-model="number" thousand-group-style="thousand" />
64+
</template>
65+
```
4466

4567
## Testing
4668

@@ -52,6 +74,10 @@ bun test
5274

5375
Please see our [releases](https://github.com/stackjs/ts-inputs/releases) page for more information on what has changed recently.
5476

77+
## Stargazers
78+
79+
[![Stargazers](https://starchart.cc/stacksjs/ts-inputs.svg?variant=adaptive)](https://starchart.cc/stacksjs/ts-inputs)
80+
5581
## Contributing
5682

5783
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ layout: home
44

55
hero:
66
name: "ts-inputs"
7-
text: "Smart Input Formatting for TypeScript"
7+
text: "Modern input masking"
88
tagline: "A comprehensive library for formatting and validating various input types"
99
image: /images/logo-white.png
1010
actions:

docs/public/images/og-image.png

29.3 KB
Loading

0 commit comments

Comments
 (0)