diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..755b60589 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing to the ParseSwift SDK + +We really want the ParseSwift SDK to be yours, to see it grow and thrive in the open source community. + +If you are not familiar with Pull Requests and want to know more about them, you can visit the [Creating a pull request](https://help.github.com/articles/creating-a-pull-request/) article. It contains detailed information about the process. + +## Setting up your local machine + +* [Fork](https://github.com/parse-community/Parse-Swift) this project and clone the fork on to your local machine: + +```sh +$ git clone https://github.com/parse-community/Parse-Swift +$ cd Parse-Swift # go into the clone directory +``` + +* Please install [SwiftLint](https://github.com/realm/SwiftLint) to ensure that your PR conforms to our coding standards: + +```sh +$ brew install swiftlint +``` + +* Please see [this comment](https://github.com/parse-community/Parse-Swift/pull/12#issuecomment-656918156) for details on developing with and testing the SDK. + +## Evolution + +This SDK is still in it's early phases. It's not intended as a port of the Parse Objective-c SDK and has many new philosophies. Please see [this thread](https://github.com/parse-community/Parse-Swift/issues/3) for a detailed discussion about the intended evolution of this SDK. + +## Code of Conduct + +This project adheres to the [Contributor Covenant Code of Conduct](https://github.com/parse-community/.github/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to honor this code. diff --git a/LICENSE b/LICENSE index 155759de5..174bd295f 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2017 Parse +Copyright (c) 2020 Parse Community Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index ad9333b31..5ffec655b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,74 @@ -# Parse-Swift +

+ Parse Platform + +

-> There is currently no maintainer for this repository, new maintainers are welcome here or on the Parse Objective-c SDK +

ParseSwift

-[EXPERIMENTAL] Parse pure Swift SDK +

+ An experimental pure Swift library that gives you access to the powerful Parse Server backend from your Swift applications. +

+ +

+ Follow on Twitter + License + Backers on Open Collective + Sponsors on Open Collective +

+ +

+ Dependencies + Build status + Join the conversation +

+
+ +For more information about the Parse Platform and its features, see the public [documentation][docs]. + +## Installation + +As there are currently no releases of the ParseSwift SDK you will need to specify either a branch or a specific commit with your chosen package manager. The `master` branch may be unstable and there may be breaking changes. + +### [Swift Package Manager](https://swift.org/package-manager/) + +You can use The Swift Package Manager to install ParseSwift by adding the following description to your `Package.swift` file: + +```swift +// swift-tools-version:5.0 +import PackageDescription + +let package = Package( + name: "YOUR_PROJECT_NAME", + dependencies: [ + .package(url: "https://github.com/parse-community/Parse-Swift.git", .branch("master")"), + ] +) +``` +Then run `swift build`. + +### [CocoaPods](https://cocoapods.org) + +Add the following line to your Podfile: +```ruby +pod 'ParseSwift', :git => 'https://github.com/parse-community/Parse-Swift', :branch => 'master' +``` + +Run `pod install`, and you should now have the latest version from the master branch. Please be aware that as this SDK is still in development there may be issues with master. + +### [Carthage](https://github.com/carthage/carthage) + +Add the following line to your Cartfile: +``` +github "parse-community/Parse-Swift" "master" +``` +Run `carthage update`, and you should now have the latest version of ParseSwift SDK in your Carthage folder. + +## iOS Usage Guide + +After installing ParseSwift, to use it first `import ParseSwift` in your AppDelegate.swift and then add the following code in your `application:didFinishLaunchingWithOptions:` method: +```swift +ParseSwift.initialize(applicationId: "xxxxxxxxxx", clientKey: "xxxxxxxxxx", serverURL: URL(string: "https://example.com")!) +``` +Please chechout the [Swift Playground](https://github.com/parse-community/Parse-Swift/tree/master/ParseSwift.playground) for more usage information. + +[docs]: http://docs.parseplatform.org/ios/guide/ diff --git a/logo large.png b/logo large.png new file mode 100644 index 000000000..16c5c8d5a Binary files /dev/null and b/logo large.png differ