Skip to content
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
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,8 @@ DerivedData
*.xcuserstate

timeline.xctimeline
Pods
Carthage/Checkouts
Carthage/Build
.idea
Podfile.lock
.DS_Store
.build
9 changes: 0 additions & 9 deletions .jazzy.yaml

This file was deleted.

1 change: 0 additions & 1 deletion .swift-version

This file was deleted.

1 change: 0 additions & 1 deletion .swiftlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ opt_in_rules: # some rules are only opt-in
# Find all the available rules by running:
# swiftlint rules
excluded:
- Carthage
- ExampleApp
- Tests
- .build
Expand Down
25 changes: 0 additions & 25 deletions .travis.yml

This file was deleted.

1 change: 0 additions & 1 deletion Cartfile

This file was deleted.

1 change: 0 additions & 1 deletion Cartfile.private

This file was deleted.

1 change: 0 additions & 1 deletion Cartfile.resolved

This file was deleted.

21 changes: 13 additions & 8 deletions HOW_TO_RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# How to release

## Steps that needs to be done to release new version
Consumers integrate this fork through the Swift Package Manager and pin a tag, so a
release is a tag plus a GitHub release — there are no artifacts to build or upload.

- add new change log to `Changelog.md`
- change `RxBluetoothKit.podspec` with new library version
- generate new doc by running script `./scripts/generate-docs.sh x.x.x`
- create archive by running `carthage build --no-skip-current && carthage archive RxBluetoothKit`
- create new Pull Request with that changes and merge it
- create new release on github and add archive previously created
- add library to cocoapods trunk by running: `pod trunk push RxBluetoothKit.podspec`
1. Add a section for the new version at the top of [CHANGELOG.md](CHANGELOG.md).
2. Open a pull request with that change and merge it once the build workflow is green.
3. Tag the merge commit with the bare version number — `6.4.0`, not `v6.4.0`, to match
the existing tags — and push the tag.
4. Create a GitHub release from that tag, using the changelog section as its notes.

Raising the required RxSwift range breaks anyone pinned to an older RxSwift: the manifest
allows one minor at a time, and Swift Package Manager resolves a single RxSwift across the
whole consumer graph, so both cannot be satisfied. Decide the version number with that in
mind rather than by habit, and say so in the changelog.
37 changes: 2 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@
/>
</p>

[![CI Status](http://img.shields.io/travis/Polidea/RxBluetoothKit.svg?style=flat)](https://travis-ci.org/Polidea/RxBluetoothKit)
[![Platform](https://img.shields.io/cocoapods/p/RxBluetoothKit.svg?style=flat)](http://cocoapods.org/pods/RxBluetoothKit)
[![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

RxBluetoothKit is a Bluetooth library that makes interaction with BLE devices much more pleasant. It's backed by RxSwift and CoreBluetooth and it provides nice API, for both Central and Peripheral modes. All to work with and make your code more readable, reliable and easier to maintain.

Here is a sneak peek of what you can do with RxBluetoothKit:
Expand Down Expand Up @@ -68,26 +64,6 @@ Want to migrate from 4.x to 5.x? Check guidelines [here](https://github.com/Poli

# Installation

## CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for CocoaProjects.
To integrate RxBluetoothKit into your Xcode project using CocoaPods specify it in your `Podfile`:
```ruby
pod 'RxBluetoothKit_Airthings'
```
Then, run the following command:
`$ pod install`

## Carthage

#### FYI: Carthage has some issues with Xcode 12 or later. Therefore it is not supported properly. Always welcome developers to fix it.

~[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
To integrate RxBluetoothKit into your Xcode project using Carthage specify it in your `Cartfile`:~
```swift
github "Polidea/RxBluetoothKit"
```
~Then, run `carthage update` to build framework and drag `RxBluetoothKit.framework` into your Xcode project.~

## Swift Package Manager

Versions >= 4.0 of the library integrate with the Swift Package Manager. In order to do that please specify our project as one of your dependencies in `Package.swift` file.
Expand All @@ -112,14 +88,5 @@ Learn more about Polidea's BLE services [here](https://www.polidea.com/services/

# Requirements

- iOS 9.0+
- OSX 10.13+
- watchOS 4.0+
- tvOS 11.0+
- Xcode 11.4+

## Swift versions
* 3.0 version supports Swift 3.0 and 3.1
* 5.0 version supports Swift 3.2 and 4.0
* 5.1.2 version supports Swift 4.1
* 5.2 version supports Swift 5.0 and 4.2
The supported platform versions and the Swift tools version are declared in
[Package.swift](Package.swift).
32 changes: 0 additions & 32 deletions RxBluetoothKit_Airthings.podspec

This file was deleted.

Loading