Skip to content

Commit 131606d

Browse files
committed
👌 IMPROVE: keywords and description to package.json
1 parent d0e9ab1 commit 131606d

File tree

4 files changed

+31
-24
lines changed

4 files changed

+31
-24
lines changed

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@ demo-app/
1616
src/
1717
rollup.config.js
1818
tsconfig.json
19+
dev.md

dev.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ cd demo-app
99
npm link react-ui-scrollspy
1010
```
1111

12-
## commit messages
12+
## Commit Messages
1313

1414
https://github.com/ahmadawais/Emoji-Log
1515

@@ -23,13 +23,7 @@ git commit -m "🤖 TEST: "
2323
git commit -m "‼️ BREAKING: "
2424
```
2525

26-
- [x] callbacks
27-
- [x] offset props
28-
- [x] relative positioning handled
29-
- [x] customise data attributes
30-
- [x] description, keywords
26+
## TODO
27+
3128
- [ ] deploy test website on github pages
32-
- [x] update docs
3329
- [ ] deploy as version 2
34-
35-
- [ ] on scroll top and onscrollbottom fix

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,33 @@
11
{
22
"name": "react-ui-scrollspy",
33
"version": "1.0.2",
4-
"description": "## Comands",
4+
"description": "Simple, Easy To Use and Customisable ScrollSpy component for react with callback, typescript, throttle support among others",
55
"main": "dist/index.js",
66
"scripts": {
77
"build": "rollup -c",
88
"start": "rollup -c -w"
99
},
10-
"files": [
11-
"dist"
10+
"repository": {
11+
"type": "git",
12+
"url": "git+https://github.com/pettiboy/react-ui-scrollspy.git"
13+
},
14+
"bugs": {
15+
"url": "https://github.com/pettiboy/react-ui-scrollspy/issues"
16+
},
17+
"homepage": "https://github.com/pettiboy/react-ui-scrollspy#readme",
18+
"author": "Hussain Pettiwala",
19+
"license": "MIT",
20+
"keywords": [
21+
"react",
22+
"react-component",
23+
"ui",
24+
"typescript",
25+
"component",
26+
"onscroll",
27+
"scroll",
28+
"spy",
29+
"performant",
30+
"scrollspy"
1231
],
1332
"peerDependencies": {
1433
"react": "^17.0.2",
@@ -25,14 +44,7 @@
2544
"rollup-plugin-typescript2": "^0.30.0",
2645
"typescript": "^4.4.4"
2746
},
28-
"repository": {
29-
"type": "git",
30-
"url": "git+https://github.com/pettiboy/react-ui-scrollspy.git"
31-
},
32-
"author": "Hussain Pettiwala",
33-
"license": "MIT",
34-
"bugs": {
35-
"url": "https://github.com/pettiboy/react-ui-scrollspy/issues"
36-
},
37-
"homepage": "https://github.com/pettiboy/react-ui-scrollspy#readme"
47+
"files": [
48+
"dist"
49+
]
3850
}

0 commit comments

Comments
 (0)