Add quick start #35
Merged
Add quick start #35
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Once #36 is merged I can add the changes from this PR to the changelog. |
thomashoneyman
approved these changes
Oct 11, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the change
This PR adds a quick start for the library.
The quick start shows a minimal example of using the PureScript FFI to deal with a
null-returning function usingNullable. The example follows the guidance of the PureScript FFI tips to help promote good FFI practices.The code used in the quick start also lives under
examplesso that it can be built/tested for accuracy.Resolves #31.
Checklist:
Added a test for the contribution (if applicable)