Skip to content

Commit f73a7f4

Browse files
committed
Merge branch 'main' of github.com:smitpatelx/string-utils into main
2 parents bbd2dcf + ad8f615 commit f73a7f4

File tree

2 files changed

+49
-12
lines changed

2 files changed

+49
-12
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Smit Patel
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

packages/string-utils/README.md

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,32 @@
66
- Gzipped size: 515 B
77
- Simple
88

9-
<span class="badge-npmversion"><a href="https://npmjs.org/package/@smitpatelx/string-utils" title="View this project on NPM"><img src="https://img.shields.io/npm/v/@smitpatelx/string-utils.svg" alt="NPM version" /></a></span>
10-
<span class="badge-npmdownloads"><a href="https://npmjs.org/package/@smitpatelx/string-utils" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/@smitpatelx/string-utils.svg" alt="NPM downloads" /></a></span>
11-
12-
# Install
13-
- NPM - ```js
14-
npm i @smitpatelx/string-utils
15-
```
16-
- Yarn - ```js
17-
yarn add @smitpatelx/string-utils
18-
```
9+
![VERSION](https://img.shields.io/npm/v/@smitpatelx/string-utils)
10+
![MONTHLY_DOWNLOADS](https://img.shields.io/npm/dm/@smitpatelx/string-utils)
11+
![NPM](https://img.shields.io/npm/l/@smitpatelx/string-utils?color=blue)
12+
13+
# Contribution
14+
This is an open-source project, feel free to contribute to this awesome project.<br/>
15+
Best way to do this:
16+
1. Fork the project
17+
2. Create a branch `<current_version>-<github_username>-<keyword>`. Example: `1.0.0-smitpatelx-changesToIsEmpty`
18+
3. Make a pull request
19+
4. Make sure not to change version in package.json (That will be done in next release)
20+
21+
# Installation
22+
- NPM
23+
```js
24+
npm i @smitpatelx/string-utils
25+
```
26+
- Yarn
27+
```js
28+
yarn add @smitpatelx/string-utils
29+
```
30+
- CDN
31+
```html
32+
<script src="https://cdn.jsdelivr.net/npm/@smitpatelx/string-utils@latest/src/lib/string-utils.js"></script>
33+
```
34+
- [Codepen](https://codepen.io/smitpatelx/full/XWzRovO/)
1935

2036
# Use
2137
```js
@@ -70,11 +86,11 @@ Apple
7086

7187
#### RemoveWhiteSpace
7288
```js
73-
removeWhiteSpace('111 222 333 444 000')
89+
removeWhiteSpace('111\n222\t333\n444\n\t000')
7490
removeWhiteSpace(' This \t is awesome \n\n\t library\n! ')
7591

7692
// Output
77-
111222333444000
93+
111 222 333 444 000
7894
This is awesome library !
7995
```
8096

0 commit comments

Comments
 (0)