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
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
75 changes: 72 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,74 @@
# Parse-Swift
<p align="center">
<img alt="Parse Platform" src="logo large.png" width="200">
</a>
</p>

> There is currently no maintainer for this repository, new maintainers are welcome here or on the Parse Objective-c SDK
<h2 align="center">ParseSwift</h2>

[EXPERIMENTAL] Parse pure Swift SDK
<p align="center">
An experimental pure Swift library that gives you access to the powerful Parse Server backend from your Swift applications.
</p>

<p align="center">
<a href="https://twitter.com/intent/follow?screen_name=parseplatform"><img alt="Follow on Twitter" src="https://img.shields.io/twitter/follow/parseplatform?style=social&label=Follow"></a>
<a href=" https://github.com/parse-community/Parse-Swift/blob/master/LICENSE"><img alt="License" src="https://img.shields.io/badge/license-MIT-lightgrey.svg"></a>
<a href="#backers"><img alt="Backers on Open Collective" src="https://opencollective.com/parse-server/backers/badge.svg" /></a>
<a href="#sponsors"><img alt="Sponsors on Open Collective" src="https://opencollective.com/parse-server/sponsors/badge.svg" /></a>
</p>

<p align="center">
<a href="https://github.com/parse-community/Parse-Swift"><img alt="Dependencies" src="https://img.shields.io/badge/dependencies-0-yellowgreen.svg"></a>
<a href="https://travis-ci.org/parse-community/Parse-Swift/branches"><img alt="Build status" src="https://img.shields.io/travis/parse-community/Parse-Swift/master.svg"></a>
<a href="https://community.parseplatform.org/"><img alt="Join the conversation" src="https://img.shields.io/discourse/https/community.parseplatform.org/topics.svg"></a>
</p>
<br>

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/
Binary file added logo large.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.