Skip to content

Commit

Permalink
Update README, bump versions
Browse files Browse the repository at this point in the history
  • Loading branch information
Mazyod committed May 7, 2020
1 parent 826ab12 commit eb6d29c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 21 deletions.
26 changes: 7 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,12 @@
</h1>

<p align="center">
<img alt="Version" src="https://img.shields.io/badge/version-3.0.1-blue.svg" />
<a alt="Travis CI" href="https://travis-ci.org/SwiftKitz/Storez">
<img alt="Version" src="https://travis-ci.org/SwiftKitz/Storez.svg?branch=master" />
<img alt="Version" src="https://img.shields.io/badge/version-4.0.0-blue.svg" />
<a alt="Github CI" href="https://github.com/SwiftKitz/Storez/actions">
<img alt="Version" src="https://github.com/SwiftKitz/Storez/workflows/Swift/badge.svg" />
</a>
<img alt="Swift" src="https://img.shields.io/badge/swift-5.0-orange.svg" />
<img alt="Swift" src="https://img.shields.io/badge/swift-5.2-orange.svg" />
<img alt="Platforms" src="https://img.shields.io/badge/platform-ios%20%7C%20osx%20%7C%20watchos%20%7C%20tvos-lightgrey.svg" />
<a alt="Carthage Compatible" href="https://github.com/SwiftKitz/Notificationz#carthage">
<img alt="Carthage" src="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat" />
</a>
</p>

## Highlights
Expand Down Expand Up @@ -166,12 +163,10 @@ struct MyKey<G: Namespace, V>: KeyType {

## Getting Started

### Carthage

[Carthage][carthage-link] is fully supported. Simply add the following line to your [Cartfile][cartfile-docs]:
### Swift Package Manager

```ruby
github "SwiftKitz/Storez"
```
TODO: Write me
```

### CocoaPods
Expand All @@ -182,13 +177,6 @@ github "SwiftKitz/Storez"
pod 'Storez/UserDefaults'
```

### Submodule

For manual installation, you can grab the source directly or through git submodules, then simply:

+ Drop the `Storez.xcodeproj` file as a subproject (make sure `Copy resources` is __not__ enabled)
+ Navigate to your root project settings. Under "Embedded Binaries", click the "+" button and select the `Storez.framework`

## Motivation

I've seen a lot of great attempts at statically-types data stores, but they all build a tightly coupled design that limits the end-developer's freedom. With this framework, you can start prototyping right away with the shipped features, then replace the persistence store and `KeyType` functionality with your heart's content __and__ keep your code the way it is!
Expand Down
4 changes: 2 additions & 2 deletions Storez.podspec
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Pod::Spec.new do |s|

s.name = "Storez"
s.version = "3.0.1"
s.version = "4.0.0"
s.summary = "Safe, statically-typed, store-agnostic key-value storage!"
s.description = <<-DESC
Provides an extremely flexible way to implement a statically
Expand All @@ -11,7 +11,7 @@ Pod::Spec.new do |s|

s.homepage = "http://swiftkitz.github.io"
s.license = "MIT"
s.source = { :git => "https://github.com/SwiftKitz/Storez.git", :tag => "v3.0.1" }
s.source = { :git => "https://github.com/SwiftKitz/Storez.git", :tag => "4.0.0" }
s.author = { "Maz Jaleel" => "[email protected]" }
s.social_media_url = "http://twitter.com/SwiftKitz"

Expand Down

0 comments on commit eb6d29c

Please sign in to comment.