Skip to content

Updating readme to include typings instructions #1

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 1 commit into from
May 30, 2016
Merged

Updating readme to include typings instructions #1

merged 1 commit into from
May 30, 2016

Conversation

kpes
Copy link
Contributor

@kpes kpes commented May 29, 2016

Updating the readme to include instructions for installing or updating via Typings

Updating the readme to include instructions for installing or updating via Typings
@christhomas
Copy link
Contributor

christhomas commented May 29, 2016

Ah yes, this is something I was missing, thanks.

There is another way to do this too, I would put the following instructions instead, what do you think.

Installation

  • npm install react-bootstrap --save-dev
  • npm install react-bootstrap-typescript --save-dev

Usage Instructions

instead of:
import { Row } from "react-bootstrap";

replace with:
import { Row } from "react-boostrap-typescript";

This is what I've been doing in my projects and it's working fine, but I suppose your way lets you continue working with react-bootstrap in a normal way? by letting you import from "react-bootstrap" like normal? I wasn't able to try your instructions yet, because I'm not at my development computer, so i'll try it out on monday.

@kpes
Copy link
Contributor Author

kpes commented May 29, 2016

Yep, using typings does let the user continue on in a more normal way (or so is my opinion). It would also allow for switching between definitions (say if there was another more up to date?) without having to change code much.

@christhomas
Copy link
Contributor

yes, you have a good point, the way I was doing it means you keep having to change where you're importing from.

@christhomas christhomas merged commit 8254b72 into react-bootstrap:master May 30, 2016
@kpes kpes deleted the typingsInstructions branch May 30, 2016 12:16
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.

2 participants