<commit_before># SpreadKit

Welcome to SpreadKit. SpreadKit is an iOS Framework to interact with the [Spreadshirt](http://spreadshirt.net) API.

With SpreadKit, you can integrate catalog browsing, product creation and basket management into your iOS App. This guide will help you to get up and running with SpreadKit.

For useful information regarding the Spreadshirt API and a reference of all the resources, have a look at the [Spreadshirt Developer Network](https://developer.spreadshirt.net) (SDN). There you can find out what is possible with the Spreadshirt API and get ideas for what you want to build using it.

### Prerequisites

SpreadKit was written exclusively for iOS, starting with Version 5.0. Currently, there are no plans for a Mac OS X framework.

In order to be able to, for example, create products and baskets, you need to apply for an API key at the [SDN](https://developer.spreadshirt.net).

It is strongly encouraged that you use [CocoaPods](http://http://cocoapods.org) for managing your project's dependencies, mainly for two reasons: (1) SpreadKit installation will be much easier this way and (2) It is awesome :).

### Caveats

The following features have not been implemented yet, but are planned:

* support for the [Spreadshirt Order API](https://developer.spreadshirt.net/display/API/Order+Resources)
* support for text configurations on products
* support for supplying search queries on get requests
* [session](https://developer.spreadshirt.net/display/API/Security#Security-ExampleAPIKeySessionId%3A) support 

## Setup

The only supported way to install SpreadKit into your project is via [CocoaPods](http://http://cocoapods.org), and it is quite simple. If you have not already, create a file named `Podfile` in your project root and include the following lines:

```ruby
platform :ios, '5.0'
pod 'SpreadKit', :git => 'git://github.com/spreadshirt/SpreadKit.git', :tag => '1.0'
```

Assuming you have installed CocoaPods (`sudo gem install cocoapods && pod setup`), you can run `pod install` and open the created `.xcworkspace` file with Xcode.

In your code, wherever you need SpreadKit, just: 

```objc
#import <SpreadKit/SpreadKit.h>
```

(or do it in your prefix header) and you are ready to roll.

## Initialization

The Main entry point for SpreadKit is the `SPClient` class. It represents the main interface for all your calls to the Spreadshirt API. It can be either initialized scoped to a user or a shop, depending on your application. The initialization is done with:

```objc
[SPClient clientWithShopId:@"yourShopID"
                 andApiKey:@"yourAPIKey" 
                 andSecret:@"yourSecret"
               andPlatform:SPPlatformEU];
```
or:
<commit_msg>update README for new installation instructions<commit_after># SpreadKit

Welcome to SpreadKit. SpreadKit is an iOS Framework to interact with the [Spreadshirt](http://spreadshirt.net) API.

With SpreadKit, you can integrate catalog browsing, product creation and basket management into your iOS App. This guide will help you to get up and running with SpreadKit.

For useful information regarding the Spreadshirt API and a reference of all the resources, have a look at the [Spreadshirt Developer Network](https://developer.spreadshirt.net) (SDN). There you can find out what is possible with the Spreadshirt API and get ideas for what you want to build using it.

### Prerequisites

SpreadKit was written exclusively for iOS, starting with Version 5.0. Currently, there are no plans for a Mac OS X framework.

In order to be able to, for example, create products and baskets, you need to apply for an API key at the [SDN](https://developer.spreadshirt.net).

It is strongly encouraged that you use [CocoaPods](http://http://cocoapods.org) for managing your project's dependencies, mainly for two reasons: (1) SpreadKit installation will be much easier this way and (2) It is awesome :).

### Caveats

The following features have not been implemented yet, but are planned:

* support for the [Spreadshirt Order API](https://developer.spreadshirt.net/display/API/Order+Resources)
* support for text configurations on products
* support for supplying search queries on get requests
* [session](https://developer.spreadshirt.net/display/API/Security#Security-ExampleAPIKeySessionId%3A) support 

## Setup

The only supported way to install SpreadKit into your project is via [CocoaPods](http://http://cocoapods.org), and it is quite simple. If you have not already, create a file named `Podfile` in your project root and include the following lines:

```ruby
platform :ios, '5.0'
pod 'SpreadKit', '~> 1.0'
```

Assuming you have installed CocoaPods (`sudo gem install cocoapods && pod setup`), you can run `pod install` and open the created `.xcworkspace` file with Xcode. This will have installed the current SpreadKit version (`~> 1.0` means it will install the most recent 1.x version).

In your code, wherever you need SpreadKit, just: 

```objc
#import <SpreadKit/SpreadKit.h>
```

(or do it in your prefix header) and you are ready to roll.

## Initialization

The Main entry point for SpreadKit is the `SPClient` class. It represents the main interface for all your calls to the Spreadshirt API. It can be either initialized scoped to a user or a shop, depending on your application. The initialization is done with:

```objc
[SPClient clientWithShopId:@"yourShopID"
                 andApiKey:@"yourAPIKey" 
                 andSecret:@"yourSecret"
               andPlatform:SPPlatformEU];
```
or:

{'fraction_non_alphanumeric': 0.08064516129032258, 'fraction_numerical': 0.0038057267125770206, 'mean_word_length': 4.432086614173229, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 9, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3557391', 'n_tokens_mistral': 1555, 'n_tokens_neox': 1438, 'n_words': 716}