Skip to content

Add typescript note to README #478

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

Merged
merged 2 commits into from
Feb 11, 2017
Merged

Add typescript note to README #478

merged 2 commits into from
Feb 11, 2017

Conversation

danzel
Copy link
Contributor

@danzel danzel commented Feb 6, 2017

It was suggested we add a typescript note in #276.

At the moment all the examples in the readme include babel, which you don't use with typescript.
I've put this in the migration to 3.0 section straight after the babel config as I think it fits there. Can't think up enough to say to give typescript its own section.
Hopefully this helps anyone using typescript who runs in to the readme,

@DimitryDushkin
Copy link

It's very helpful addition!

docs/README.md Outdated
@@ -28,6 +28,16 @@
}
```

- When using **typescript**, babel is not required, so your config should look like ([demo](https://github.com/Glavin001/react-hot-ts)):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you move this section to the bottom with its own header? Also, please capitalize TypeScript/Babel.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@calesce
Copy link
Collaborator

calesce commented Feb 11, 2017

Looks great, thanks!

@calesce calesce merged commit 7eeceab into gaearon:next Feb 11, 2017
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.

3 participants