Skip to content

Commit 8b0eae2

Browse files
committed
doc(readme): improve wording
1 parent 2f4b68d commit 8b0eae2

File tree

1 file changed

+15
-21
lines changed

1 file changed

+15
-21
lines changed

README.md

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ import 'react-js-cron/dist/styles.css'
7171

7272
## Converter
7373

74-
If you want to use the converter used internally you can import it in your project:
74+
If you want to use the converter that react-js-cron uses internally, you can import it into your project:
7575

7676
```jsx
7777
import { converter } from 'react-js-cron'
@@ -98,34 +98,28 @@ The converter can also be helpful for parsing a string. Note that Sunday is repr
9898
```jsx
9999
import { converter } from 'react-js-cron'
100100

101-
const [
102-
minutes,
103-
hours,
104-
daysOfMonth,
105-
months,
106-
daysOfWeek
107-
] = converter.parseCronString('0 2,14 * * 1-5');
108-
109-
console.log('parsed cron:', {
110-
minutes,
111-
hours,
112-
daysOfMonth,
113-
months,
114-
daysOfWeek
101+
const [minutes, hours, daysOfMonth, months, daysOfWeek] =
102+
converter.parseCronString('0 2,14 * * 1-5')
103+
104+
console.log('parsed cron:', {
105+
minutes,
106+
hours,
107+
daysOfMonth,
108+
months,
109+
daysOfWeek,
115110
})
116111
```
117112

118113
```
119-
parsed cron: {
120-
minutes: [0],
121-
hours: [2, 14],
122-
daysOfMonth: [],
123-
months: [],
114+
parsed cron: {
115+
minutes: [0],
116+
hours: [2, 14],
117+
daysOfMonth: [],
118+
months: [],
124119
daysOfWeek: [1, 2, 3, 4, 5]
125120
}
126121
```
127122

128-
129123
## Examples
130124

131125
Learn more with [dynamic settings](https://xrutayisire.github.io/react-js-cron/?path=/story/reactjs-cron--dynamic-settings).

0 commit comments

Comments
 (0)