Skip to content

README: Getting Started #66

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 6 commits into from
Mar 15, 2021
Merged

README: Getting Started #66

merged 6 commits into from
Mar 15, 2021

Conversation

dfreeman
Copy link
Member

@dfreeman dfreeman commented Mar 14, 2021

Ultimately we're likely to want more content, organized better (maybe gitbook?), but for now I think this at least touches all the basics for how to set up a project and what caveats to be aware of.

@dfreeman dfreeman added the documentation Improvements or additions to documentation label Mar 14, 2021
@dfreeman dfreeman linked an issue Mar 14, 2021 that may be closed by this pull request
Copy link
Member

@chriskrycho chriskrycho left a comment

Choose a reason for hiding this comment

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

This looks great overall! The only thing I would add is a note explaining that the custom imports are not a long-term plan, just an interim until we have Official TypeScript Support (maybe with a link to the RFC!) including types that can support this more directly.

Copy link
Member

@chriskrycho chriskrycho left a comment

Choose a reason for hiding this comment

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

Thank you for tweaking that!

@dfreeman
Copy link
Member Author

I'm going to merge this and push 0.3.0 packages to npm, but we can of course make any number of follow-on edits and additions.

@dfreeman dfreeman merged commit 46ba072 into master Mar 15, 2021
@dfreeman dfreeman deleted the getting-started branch March 15, 2021 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how to set up a new project
2 participants