Skip to content

Add basic documentation #10

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 17 commits into from
Jul 19, 2020
Merged

Conversation

TomWFox
Copy link
Contributor

@TomWFox TomWFox commented Mar 9, 2019

  • Adds SPM, cocoapods, Carthage installation instructions
  • Adds contributing doc
  • Changes copyright notice in license
  • Improve readme design

@ShawnBaek
Copy link
Contributor

@Tom-Fox1 Thank you for contributing. Who is maintain parse-swift repo? We need to update the contributing guide.

@dplewis
Copy link
Member

dplewis commented Mar 31, 2019

There are no maintainer for this repo.

New maintainers are welcome

@cbaker6
Copy link
Contributor

cbaker6 commented Jul 15, 2020

@TomWFox I think we can add some of the usage/testing from #12 (comment), particularly the playgrounds part.

The project can be imported via SPM, Cocoapods, Carthage (I've never use this before, but the tests pass) by linking to the repo link directly

@cbaker6
Copy link
Contributor

cbaker6 commented Jul 19, 2020

For the Contributing guide, we can add, brew install swiftlint

@TomWFox TomWFox changed the title Add ios usage guide Add basic documentation Jul 19, 2020
@TomWFox TomWFox marked this pull request as ready for review July 19, 2020 16:44
@TomWFox
Copy link
Contributor Author

TomWFox commented Jul 19, 2020

@cbaker6 @pranjalsatija I think this is good to go now.

The details in the contributing doc are very basic right now but at some point I'll add info about setting up a Parse Server locally to test etc.

Btw I haven't actually tried the SPM or Carthage install but I think they should both work.

Copy link
Contributor

@pranjalsatija pranjalsatija left a comment

Choose a reason for hiding this comment

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

LGTM, other than the one nit!

Before we merge, I'm going to try and install this via SPM or CocoaPods and make sure it works. I'll be able to do that later tonight.

@cbaker6
Copy link
Contributor

cbaker6 commented Jul 19, 2020

@TomWFox lgtm!

I'm not sure if you should add the SwiftLint line I mentioned directly in the doc. If people don't install it locally, they may write a bunch of code that has SwiftLint errors that won't be detected until they make a PR for travis to catch. Installing it locally allows them to see errors and warnings on the fly

@pranjalsatija
Copy link
Contributor

@TomWFox just confirming that I was able to install ParseSwift, then build and launch a blank iOS single view app template using SPM and CocoaPods with no issues.

@TomWFox
Copy link
Contributor Author

TomWFox commented Jul 19, 2020

@cbaker6 good point, added

@TomWFox TomWFox merged commit 60eea57 into parse-community:master Jul 19, 2020
@TomWFox TomWFox deleted the add-ios-usage-guide branch July 19, 2020 22:53
@TomWFox
Copy link
Contributor Author

TomWFox commented Jul 19, 2020

@pranjalsatija thanks for checking, only Carthage that is untested now (by us anyway).

@pranjalsatija
Copy link
Contributor

I just tested that out too (just to be safe), it worked.

@TomWFox
Copy link
Contributor Author

TomWFox commented Jul 19, 2020

Great!

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.

5 participants