Skip to content

Commit bef57b8

Browse files
committed
Bring the README to staging state
1 parent 96627ec commit bef57b8

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
1-
# react-phone-hooks
1+
# react-phone-hooks <img src="https://github.com/typesnippet.png" align="right" height="64" />
22

3-
React hooks and utility functions for parsing and validation phone numbers.
3+
[![npm](https://img.shields.io/npm/v/react-phone-hooks)](https://www.npmjs.com/package/react-phone-hooks)
4+
[![React](https://img.shields.io/badge/react-%E2%89%A516-blue)](https://www.npmjs.com/package/react-phone-hooks)
5+
[![types](https://img.shields.io/npm/types/react-phone-hooks)](https://www.npmjs.com/package/react-phone-hooks)
6+
[![License](https://img.shields.io/npm/l/react-phone-hooks)](https://github.com/typesnippet/react-phone-hooks/blob/master/LICENSE)
7+
[![Tests](https://github.com/pysnippet/react-phone-hooks/actions/workflows/tests.yml/badge.svg)](https://github.com/pysnippet/react-phone-hooks/actions/workflows/tests.yml)
48

5-
## TODO
9+
This comprehensive toolkit features custom hooks and utility functions tailored for phone number formatting, parsing,
10+
and validation. It supports international standards, making it suitable for phone number processing applications across
11+
different countries and regions.
612

7-
- [ ] Create an example app: half screen antd-phone-input, half screen mui-phone-input
8-
- [ ] Define the set of hooks and utility functions and implement them
9-
- [ ] Create unit tests for the hooks and utility functions
10-
- [ ] Safely transfer the antd-phone-input to github.com/typesnippet
11-
- [ ] Bring the mui-phone-input to a state to be published (alpha)
12-
- [ ] Create two concurrent PRs for hooks and utility functions
13-
- [ ] Publish the hooks and utility functions
13+
## Contribute
14+
15+
Any contribution is welcome. Don't hesitate to open an issue or discussion if you have questions about your project's
16+
usage and integration. For ideas or suggestions, please open a pull request. Your name will shine on our contributors'
17+
list. Be proud of what you build!
18+
19+
## License
20+
21+
Copyright (C) 2023 Artyom Vancyan. [MIT](https://github.com/pysnippet/react-phone-hooks/blob/master/LICENSE)

0 commit comments

Comments
 (0)