Skip to content

Commit 784397f

Browse files
committed
updates to readme
1 parent 3f3b458 commit 784397f

File tree

5 files changed

+10991
-9
lines changed

5 files changed

+10991
-9
lines changed

README.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# A simple React inline editing component.
1+
# A simple React inline editing component
22

33
## Reasoning
44

5-
This npm package is originally adapted from https://github.com/bfischer/react-inline-editing. I found the package a few days ago and is super useful but un-maintained? Mainly needed it to work with TypeScript + ReactJS. The below README desc is adapted from the originator's README.
5+
This npm package is originally adapted from <https://github.com/bfischer/react-inline-editing>. I found the package a few days ago and is super useful but un-maintained? Mainly needed it to work with TypeScript + ReactJS. The below README desc is adapted from the originator's README.
66

77
This is an inline, editable text/label component built in React + TypeScript.
88

@@ -15,8 +15,14 @@ The `<InlineInputEdit />` allows the user to simply click and edit text inline.
1515
- `npm install --save react-inline-input-edit`
1616
- `yarn add react-inline-input-edit`
1717

18+
## Create your own
19+
20+
- to build -> `npm run build` or `yarn build`
21+
- to test -> `npm run test` or `yarn test`
22+
1823
## Component `props`
19-
_* Required_
24+
25+
(*) Required
2026

2127
| Prop | Type | Description |
2228
| ---------------- | -------- | ------------------------------------------------------------------------------------ |
@@ -38,8 +44,8 @@ _* Required_
3844
| onFocus | function | Callback for text focusing. Parameter(s): `text` |
3945
| onFocusOut | function | Callback for focus leaving editor. Parameter(s): `text` |
4046

41-
4247
## An example
48+
4349
```javascript
4450
import React, { FC } from 'react';
4551
import { InlineInputEdit } from 'react-inline-input-edit';

package-lock.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-inline-input-edit",
3-
"version": "1.0.1",
3+
"version": "1.0.2",
44
"description": "a simple inline input editor for react",
55
"main": "build/index.js",
66
"module": "build/index.es.js",
@@ -27,6 +27,7 @@
2727
"@types/react": "^16.9.43",
2828
"@types/react-dom": "^16.9.8",
2929
"@types/react-test-renderer": "^16.9.2",
30+
"dot-prop": ">=5.1.1",
3031
"jest": "^26.1.0",
3132
"react": "^16.13.1",
3233
"react-dom": "^16.13.1",
@@ -38,8 +39,7 @@
3839
"rollup-plugin-peer-deps-external": "^2.2.3",
3940
"rollup-plugin-typescript2": "^0.27.1",
4041
"ts-jest": "^26.1.3",
41-
"typescript": "^3.9.7",
42-
"dot-prop": ">=5.1.1"
42+
"typescript": "^3.9.7"
4343
},
4444
"jest": {
4545
"preset": "ts-jest",
@@ -56,5 +56,8 @@
5656
"bugs": {
5757
"url": "https://github.com/iamwill123/react-inline-input-edit/issues"
5858
},
59-
"homepage": "https://github.com/iamwill123/react-inline-input-edit#readme"
59+
"homepage": "https://github.com/iamwill123/react-inline-input-edit#readme",
60+
"publishConfig": {
61+
"registry": "https://npm.pkg.github.com/"
62+
}
6063
}

react-inline-input-edit-1.0.2.tgz

8.45 KB
Binary file not shown.

0 commit comments

Comments
 (0)