Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README.md with some minor fixes #4

Merged
merged 6 commits into from
Mar 5, 2019
Merged

Improve README.md with some minor fixes #4

merged 6 commits into from
Mar 5, 2019

Conversation

yhatt
Copy link
Owner

@yhatt yhatt commented Mar 5, 2019

This PR includes some minor fixes for README.md.

  • npm release page has some broken images. I had changed to use from relative path to absolute URL to GitHub.
  • Fix incorrect description of <DatePicker> props.
  • I received some feedback from user about the wrong installation way. Babel and TypeScript are not need to install at the same time. (But except --jsx preserve) I clarified the documentation about this.

@yhatt
Copy link
Owner Author

yhatt commented Mar 5, 2019

UPDATE: Add requirement of TypeScript >= 3.0. We are using unknown type available in TS 3.0. The notation of TS >= 2.8 might lead to be used incompatible TS 2.x wrongly.

TypeScript 2.x support is a feedback recieved from user, but I have not think to support. I've tried to change type from unknown to any, but some components throws type error.

In addition, (internally used) Node Slack SDK is planned to upgrade TS to 3.3 in next major version. (slackapi/node-slack-sdk#689) It means there is no advantage to support obsolete TS from now.

Because an useless warning is shown to JS user, peerDep is not added at this moment.

@yhatt yhatt merged commit fc5aed5 into master Mar 5, 2019
@yhatt yhatt deleted the update-readme branch March 5, 2019 08:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant