Virtual Stores Position Kit

Our Position related libraries.

Features

• TBD

Requirements

• Xcode 12+
• If using M1: ```gem install --user-install ffi -- --enable-libffi-alloc

- **Jazzy** ```[sudo] gem install jazzy```
- **Brew** ```/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"```
- **Make** ```brew install make```
- **Swiftlint** ```brew install swiftlint```


## Style Guide

Following our style guide should:

* Make it easier to read and begin understanding the unfamiliar code.
* Make code easier to maintain.
* Reduce simple programmer errors.
* Reduce cognitive load while coding.
* Keep discussions on diffs focused on the code's logic rather than its style.

*Note that brevity is not a primary goal.*

[Official Style Guide] (https://github.com/virtualstores/ios-style-guide)

## Installation

####Using as a dependency

``` swift
// swift-tools-version:5.5

import PackageDescription

let package = Package(
  name: "YourTestProject",
  dependencies: [
    .package(url: "https://github.com/virtualstores/ios-position-kit.git", from: "0.0.1")
  ],
  targets: [
    .target(name: "YourTestProject", dependencies: ["VSPositionKit"])
  ]
)

And then import wherever needed: import VSPositionKit

Adding it to an existent iOS Project via Swift Package Manager

1. Using Xcode 11 go to File > Swift Packages > Add Package Dependency
2. Paste the project URL: https://github.com/virtualstores/ios-position-kit.git
3. Click on next and select the project target

If you have doubts, please, check the following links:

How to use

Creating Swift Packages

After successfully retrieved the package and added it to your project, just import VSPositionKit and you can get the full benefits of it.

Usage example

import VSPositionKit

// Add some example here

Contributing to the library

1. Clone the repository
2. Create your feature branch
3. Open the Package.swift file
4. Perform your changes, debug, run the unit tests
5. Make sure that all the tests pass and there are no Xcode warnings or lint issues
6. Open a pull request

We have added a few helpers to make your life easier:

1. make build to build the project via command line
2. make test to test the project via command line
3. make docs to generate the documentation and output to the Docs folder
4. make lint to execute Swiftlint
5. make fixlint to auto-correct Swiftlint warnings