Skip to content

Commit d430181

Browse files
committed
docs package.json, README.md - some useful updates
1 parent 3c710ba commit d430181

File tree

2 files changed

+36
-28
lines changed

2 files changed

+36
-28
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
![npm bundle size](https://img.shields.io/bundlephobia/min/regexify-string) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/artem-solovev/regexify-string) ![npm](https://img.shields.io/npm/dw/regexify-string)
1+
![npm bundle size](https://img.shields.io/bundlephobia/min/regexify-string) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/artem-solovev/regexify-string) <!-- ![npm-donwloads-per-week](https://img.shields.io/npm/dw/regexify-string) --> ![npm-donwloads-per-year](https://img.shields.io/npm/dy/regexify-string)
2+
23
---
34

45
# regexify-string
56

6-
The way to decorate string by using regex with: React components, HTML tags etc
7+
Strings decorator (by regex) with: React components, HTML tags etc.
78

89
> perfectly works with: strings, html tags, react, react-native
910
@@ -13,6 +14,10 @@ The way to decorate string by using regex with: React components, HTML tags etc
1314
```
1415
$ npm install --save regexify-string
1516
```
17+
or
18+
```
19+
$ yarn add regexify-string
20+
```
1621

1722
## API
1823

@@ -111,7 +116,7 @@ Type: `string`
111116
</Link>
112117
);
113118
},
114-
input: DisclaimerData.body,
119+
input: someVariablWithData,
115120
});
116121
```
117122

package.json

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,16 @@
11
{
22
"name": "regexify-string",
33
"version": "1.0.5",
4-
"description": "The way to decorate string by using regex with: React components, HTML tags etc.",
5-
"main": "index.js",
6-
"scripts": {
7-
"test": "jest",
8-
"build": "tsc --declaration",
9-
"--- VERSIONING ---": "",
10-
"version-patch:up": "npm version patch --no-git-tag-version --force && git add package.json package-lock.json",
11-
"version-minor:up": "npm version minor --no-git-tag-version --force && git add package.json package-lock.json",
12-
"version-major:up": "npm version major --no-git-tag-version --force && git add package.json package-lock.json"
13-
},
14-
"husky": {
15-
"hooks": {
16-
"pre-commit": "npm run version-patch:up",
17-
"pre-push": "npm run test"
18-
}
19-
},
20-
"publishConfig": {
21-
"registry-github": "https://npm.pkg.github.com/@artem-solovev",
22-
"registry-npm": "https://registry.npmjs.org/"
23-
},
4+
"description": "Strings decorator (by regex) with: React components, HTML tags etc.",
5+
"license": "MIT",
6+
"homepage": "https://github.com/artem-solovev/regexify-string#readme",
247
"repository": {
258
"type": "git",
269
"url": "git+https://github.com/artem-solovev/regexify-string.git"
2710
},
11+
"bugs": {
12+
"url": "https://github.com/artem-solovev/regexify-string/issues"
13+
},
2814
"keywords": [
2915
"regex",
3016
"react",
@@ -33,12 +19,29 @@
3319
"decoration",
3420
"parsing"
3521
],
36-
"author": "Artem Solovev",
37-
"license": "MIT",
38-
"bugs": {
39-
"url": "https://github.com/artem-solovev/regexify-string/issues"
22+
"publishConfig": {
23+
"registry-github": "https://npm.pkg.github.com/@artem-solovev",
24+
"registry-npm": "https://registry.npmjs.org/"
25+
},
26+
"main": "index.js",
27+
"types": "index.d.ts",
28+
"authors": [
29+
"Artem Vadimovich Solovev <artem.solovev.lse@gmail.com> (https://github.com/artem-solovev)"
30+
],
31+
"husky": {
32+
"hooks": {
33+
"pre-commit": "npm run version-patch:up",
34+
"pre-push": "npm run test"
35+
}
36+
},
37+
"scripts": {
38+
"test": "jest",
39+
"build": "tsc --declaration",
40+
"--- VERSIONING ---": "",
41+
"version-patch:up": "npm version patch --no-git-tag-version --force && git add package.json package-lock.json",
42+
"version-minor:up": "npm version minor --no-git-tag-version --force && git add package.json package-lock.json",
43+
"version-major:up": "npm version major --no-git-tag-version --force && git add package.json package-lock.json"
4044
},
41-
"homepage": "https://github.com/artem-solovev/regexify-string#readme",
4245
"devDependencies": {
4346
"@types/jest": "^26.0.4",
4447
"@types/node": "^14.0.20",

0 commit comments

Comments
 (0)