Skip to content

Commit b2161a7

Browse files
Update props section.
1 parent a158309 commit b2161a7

File tree

1 file changed

+7
-23
lines changed

1 file changed

+7
-23
lines changed

README.md

+7-23
Original file line numberDiff line numberDiff line change
@@ -63,31 +63,15 @@ class App extends React.Component {
6363

6464
ReactDOM.render(<App/>, document.body);
6565
```
66-
#### `<ReactAwesomeClock>` Props:
67-
```js
68-
69-
//
70-
// Props:
71-
//
72-
{
73-
// If set true then The clock will also show the day in clock.
74-
day: boolean, // day={true}
75-
76-
/*
77-
* Sometimes we want to show the number of days passed since we start working or
78-
* launched a project. So this prop is helpful in such cases.
79-
* You can pass the object of date which contains the start date to this prop and it will
80-
* calculate the number of days and display in days section of clock.
81-
*/
82-
startDate: string, // startDate="2017-06-01"
8366

84-
// Sets the separator between days, hours and minutes. We are using . as the default separator.
85-
clockSeparator: string, // clockSeparator="."
86-
87-
// Set the styles of the app, you can pass in any valid styles here.
88-
style: object, // style={{ color: "lightGrey" }}
67+
#### `<ReactAwesomeClock>` Props:
8968

90-
```
69+
|Prop name|Type|Description|Example values|
70+
|----|----|----|----|
71+
|day|`boolean`|Displays the day section.|`day={true}`|
72+
|startDate|`string`|Displays the date count from startDate.|`startDate="2017-06-01"`|
73+
|clockSeparator|`string`|Sets the separator between days, hours and minutes. We are using `.` as the default separator|`clockSeparator="."`|
74+
|style|`object`|Sets the styles of the app, you can pass in any valid styles here.|`style={{ color: "lightGrey" }}`|
9175

9276
## Contributing
9377

0 commit comments

Comments
 (0)