Skip to content

Add quick start #22

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Aug 27, 2021
Merged

Add quick start #22

merged 2 commits into from
Aug 27, 2021

Conversation

@maxdeviant
Copy link
Member

@maxdeviant maxdeviant commented Aug 27, 2021

Description of the change

Add a quick start guide to the README.

Resolves #16.

Checklist:

  • Added the change to the changelog's "Unreleased" section with a link to this PR and your username
  • Linked any existing issues or proposals that this pull request should close
  • Updated or added relevant documentation in the README and/or documentation directory
  • Added a test for the contribution (if applicable)

@maxdeviant maxdeviant self-assigned this Aug 27, 2021
maxdeviant
maxdeviant commented Aug 27, 2021
View reviewed changes
README.md
import Effect.Console
import Effect.Now
printCurrentYear :: Effect Unit
Copy link
Member Author

@maxdeviant maxdeviant Aug 27, 2021

Choose a reason for hiding this comment

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

Let me know how this example is.

I tried to err on the side of being slightly more verbose and trying to work with the dates rather than just showing the functions being called in the REPL:

> nowDate
(Date (Year 2021) August (Day 27))

Copy link
Contributor

@thomashoneyman thomashoneyman Aug 27, 2021

Choose a reason for hiding this comment

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

That’s good — it’s better to show them in context and typical use vs. just their output.

@maxdeviant maxdeviant requested a review from a team August 27, 2021 02:15
thomashoneyman
thomashoneyman approved these changes Aug 27, 2021
View reviewed changes
Copy link
Contributor

@thomashoneyman thomashoneyman left a comment

Choose a reason for hiding this comment

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

Thanks!

@thomashoneyman thomashoneyman merged commit dde4a38 into purescript-contrib:main Aug 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@thomashoneyman thomashoneyman thomashoneyman approved these changes

Assignees

@maxdeviant maxdeviant

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Repository doesn't have a quick start section in the README

2 participants

@maxdeviant @thomashoneyman