Skip to content

Commit

Permalink
MOD: <README>
Browse files Browse the repository at this point in the history
  • Loading branch information
RyukieSama committed Jul 19, 2022
1 parent 7518eb6 commit 3a498b6
Show file tree
Hide file tree
Showing 3 changed files with 139 additions and 21 deletions.
6 changes: 4 additions & 2 deletions Example/Swifty.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@

/* Begin PBXFileReference section */
1AF9C4A17B1B7CC66BB7059A /* Pods-Swifty_Example.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Swifty_Example.debug.xcconfig"; path = "Target Support Files/Pods-Swifty_Example/Pods-Swifty_Example.debug.xcconfig"; sourceTree = "<group>"; };
4A4716CC2886C121008F0888 /* RyukieSwifty.podspec */ = {isa = PBXFileReference; lastKnownFileType = text; name = RyukieSwifty.podspec; path = ../RyukieSwifty.podspec; sourceTree = "<group>"; };
4A4716CD2886C1DE008F0888 /* README-EN.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; name = "README-EN.md"; path = "../README-EN.md"; sourceTree = "<group>"; };
4A6B15B327C8E1CA002FE02D /* Swifty_Example-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "Swifty_Example-Bridging-Header.h"; sourceTree = "<group>"; };
4A6B15B427C8E1CA002FE02D /* OCScreenShieldViewController.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OCScreenShieldViewController.h; sourceTree = "<group>"; };
4A6B15B527C8E1CA002FE02D /* OCScreenShieldViewController.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OCScreenShieldViewController.m; sourceTree = "<group>"; };
Expand All @@ -48,7 +50,6 @@
607FACEA1AFB9204008FA782 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
607FACEB1AFB9204008FA782 /* Tests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Tests.swift; sourceTree = "<group>"; };
6450F35550C454283B856F1D /* Pods-Swifty_Tests.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Swifty_Tests.debug.xcconfig"; path = "Target Support Files/Pods-Swifty_Tests/Pods-Swifty_Tests.debug.xcconfig"; sourceTree = "<group>"; };
6BAE03E833723D9C74916C69 /* Swifty.podspec */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = file; name = Swifty.podspec; path = ../Swifty.podspec; sourceTree = "<group>"; };
717E58701AD8D08EC3CE16AB /* Pods-Swifty_Example.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Swifty_Example.release.xcconfig"; path = "Target Support Files/Pods-Swifty_Example/Pods-Swifty_Example.release.xcconfig"; sourceTree = "<group>"; };
D2CB8851F86F28D0BE1BA9E6 /* Pods_Swifty_Tests.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Swifty_Tests.framework; sourceTree = BUILT_PRODUCTS_DIR; };
E03FD393C41AC8AAE09D3B63 /* Pods_Swifty_Example.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Swifty_Example.framework; sourceTree = BUILT_PRODUCTS_DIR; };
Expand Down Expand Up @@ -142,8 +143,9 @@
607FACF51AFB993E008FA782 /* Podspec Metadata */ = {
isa = PBXGroup;
children = (
6BAE03E833723D9C74916C69 /* Swifty.podspec */,
4A4716CC2886C121008F0888 /* RyukieSwifty.podspec */,
FB3B8FFFF59D51DD07B23BF8 /* README.md */,
4A4716CD2886C1DE008F0888 /* README-EN.md */,
4F750B31E25159932FB1494C /* LICENSE */,
);
name = "Podspec Metadata";
Expand Down
121 changes: 121 additions & 0 deletions README-EN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# Swifty - Make swift code swifty

[中文](README.md) | English

[![CI Status](https://img.shields.io/travis/RyukieSama/RyukieSwifty.svg?style=flat)](https://travis-ci.org/RyukieSama/RyukieSwifty)
[![Version](https://img.shields.io/cocoapods/v/RyukieSwifty.svg?style=flat)](https://cocoapods.org/pods/RyukieSwifty)
[![License](https://img.shields.io/cocoapods/l/RyukieSwifty.svg?style=flat)](https://cocoapods.org/pods/RyukieSwifty)
[![Platform](https://img.shields.io/cocoapods/p/Swifty.svg?style=flat)](https://cocoapods.org/pods/RyukieSwifty)

## 1. Example

To run the example project, clone the repo, and run `pod install` from the Example directory first.

## 2. All install

```ruby
pod 'RyukieSwifty'
```

## 3. Subspec install

### 3.1 UIKit Extension

```ruby
pod 'RyukieSwifty/UIKit'
```

### 3.2 CloudKit Extension

```ruby
pod 'RyukieSwifty/CloudKit'
```

### 3.3 Foundation Extension

```ruby
pod 'RyukieSwifty/Foundation'
```

### 3.4 FullScreen Extension

```ruby
pod 'RyukieSwifty/FullScreen'
```

### 3.5 Router Protocol

```ruby
pod 'RyukieSwifty/Router'
```

### 3.6 Service Protocol - MoyaStyleProtocol

Make network request code more `Moya` style more `Swifty`. Didn`t depend on any framework, easy to change and extend.

```ruby
pod 'RyukieSwifty/SwiftyServiceProtocol'
```

### 3.7 ScreenShield (>= iOS13) - 截屏防护

Light way to protect content in view form screenshort and record. Add contents you want to protect in `ScreenShieldView`, they will be hide during screenshort and record.

![ScreenShield](ScreenShield.gif)

```ruby
pod 'RyukieSwifty/ScreenShield'
```

Swift - Demo:

```Swift
import UIKit
import RyukieSwifty

class ViewController: UIViewController {
override func loadView() {
view = ScreenShieldView.create()
}
...
}
```

OC - Demo:

```C++
#import "OCScreenShieldViewController.h"
@import RyukieSwifty;

@interface OCScreenShieldViewController ()

@end

@implementation OCScreenShieldViewController

- (void)loadView {
self.view = [ScreenShieldView createWithFrame:UIScreen.mainScreen.bounds];
}

- (void)viewDidLoad {
[super viewDidLoad];

UIView *cubeView = [[UIView alloc] initWithFrame:CGRectMake(100, 100, 100, 100)];
cubeView.backgroundColor = [UIColor redColor];
[self.view addSubview:cubeView];

self.view.backgroundColor = [UIColor grayColor];
}

@end
```
## 4. Author
RyukieSama, [email protected]
## License
Swifty is available under the MIT license. See the LICENSE file for more info.
33 changes: 14 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,63 @@
# Swifty - Make swift code swifty

中文 | [English](README-EN.md)

[![CI Status](https://img.shields.io/travis/RyukieSama/RyukieSwifty.svg?style=flat)](https://travis-ci.org/RyukieSama/RyukieSwifty)
[![Version](https://img.shields.io/cocoapods/v/RyukieSwifty.svg?style=flat)](https://cocoapods.org/pods/RyukieSwifty)
[![License](https://img.shields.io/cocoapods/l/RyukieSwifty.svg?style=flat)](https://cocoapods.org/pods/RyukieSwifty)
[![Platform](https://img.shields.io/cocoapods/p/Swifty.svg?style=flat)](https://cocoapods.org/pods/RyukieSwifty)

## Example
## 一、 示例程序

To run the example project, clone the repo, and run `pod install` from the Example directory first.

## Requirements

## Installation

Swifty is available through [CocoaPods](https://cocoapods.org). To install
it, simply add the following line to your Podfile:

## All install - 安装全部
## 二、 CocoaPods 完整安装

```ruby
pod 'RyukieSwifty'
```

## Subspec install - 子模块安装
## 三、 按功能安装

### UIKit Extension
### 3.1 UIKit Extension

```ruby
pod 'RyukieSwifty/UIKit'
```

### CloudKit Extension
### 3.2 CloudKit Extension

```ruby
pod 'RyukieSwifty/CloudKit'
```

### Foundation Extension
### 3.3 Foundation Extension

```ruby
pod 'RyukieSwifty/Foundation'
```

### FullScreen Extension
### 3.4 全屏控制

```ruby
pod 'RyukieSwifty/FullScreen'
```

### Router Protocol
### 3.5 路由协议

```ruby
pod 'RyukieSwifty/Router'
```

### Service Protocol - MoyaStyleProtocol
### 3.6 网络请求接口协议 - MoyaStyleProtocol

混编项目(AFN)或者自定义网络库,通过该协议可以使 `Swift` 内容中的网络请求实现有 `Moya` 的风格,更加 `Swifty`
通过该协议可以使 `Swift` 内容中的网络请求实现有 `Moya` 的风格,更加 `Swifty`,不依赖具体第三方网络库,易于切换拓展。

```ruby
pod 'RyukieSwifty/SwiftyServiceProtocol'
```

### ScreenShield (>= iOS13) - 截屏防护
### 3.7 截屏防护 (>= iOS13)

极其轻量化的截屏防护方案,任何需要被保护的 `View` 作为子视图放入 `ScreenShieldView` 即可达到截屏时隐藏内容的效果。

Expand Down Expand Up @@ -115,7 +110,7 @@ OC - Demo:
@end
```
## Author
## 四、 作者
RyukieSama, [email protected]
Expand Down

0 comments on commit 3a498b6

Please sign in to comment.