-
Notifications
You must be signed in to change notification settings - Fork 234
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
Update README for Swift 3 #41
Conversation
I noticed whilst adding this pod (which is the 💣 by the way) to my project that the README instructions were out of date. I may have missed some bits.
Awesome! Thanks for the PR! 👍 LGTM 👌 Could you just add an entry in the CHANGELOG to mention the update and credit yourself? (yes, even if it's only only documentation: documentation is as important as code after all!) |
149b4dd
to
0fa1c1e
Compare
Done and done, good sir. Have a fantastic weekend 😎. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry just two little nitpickings in the README formatting 😉 (I should document that better in some CONTRIBUTING file some day!)
CHANGELOG.md
Outdated
@@ -1,5 +1,11 @@ | |||
# CHANGELOG | |||
|
|||
## 4.0.2 | |||
|
|||
* Updated README instructions to Swift 3. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry to be nitpicking, but could you please add 2 spaces at the end of that line?
That's a trick related to Markdown formatting: adding two spaces at the end of a line allows to go to the next line while staying in the same paragraph/bullet point
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ha I was wondering how the other entries got a new line! Yeah no worries.
CHANGELOG.md
Outdated
@@ -1,5 +1,11 @@ | |||
# CHANGELOG | |||
|
|||
## 4.0.2 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I should have told you: I usually just use ## Master
for entries not released yet
(I might not release a new version (4.0.2) just for this, and in case the next PR adds something breaking the next version might not end up being 4.0.2 but maybe 4.1.0 or whatnot 😉 )
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👌
I noticed whilst adding this pod (which is the 💣 by the way) to my project that the README instructions were out of date. I may have missed some bits.