Skip to content

Commit 2ce5a90

Browse files
authored
Added licence (#12)
1 parent 967445e commit 2ce5a90

File tree

4 files changed

+92
-1
lines changed

4 files changed

+92
-1
lines changed

LICENSE.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
Copyright (c) 2022 Canopas Software LLP
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy
5+
of this software and associated documentation files (the "Software"), to deal
6+
in the Software without restriction, including without limitation the rights
7+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8+
copies of the Software, and to permit persons to whom the Software is
9+
furnished to do so, subject to the following conditions:
10+
11+
The above copyright notice and this permission notice shall be included in
12+
all copies or substantial portions of the Software.
13+
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20+
THE SOFTWARE.

Package.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// swift-tools-version: 5.9
1+
// swift-tools-version: 5.5
22
// The swift-tools-version declares the minimum version of Swift required to build this package.
33

44
import PackageDescription

RichEditorSwiftUI.podspec

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Pod::Spec.new do |s|
2+
s.name = "RichEditorSwiftUI"
3+
s.version = "2.0.2"
4+
s.summary = "Rich text editing, SwiftUI rich text editor library."
5+
6+
s.description = <<-DESC
7+
Wrapper around UITextView to support Rich text editing in SwiftUI.
8+
DESC
9+
10+
s.homepage = "https://github.com/canopas/RichEditorSwiftUI"
11+
s.license = { :type => "MIT", :file => "LICENSE.md" }
12+
s.author = { "Divyesh" => "[email protected]" }
13+
s.source = { :git => "https://github.com/canopas/rich-editor-swiftui.git", :tag => s.version.to_s }
14+
s.source_files = "Sources/RichEditorSwiftUI/*.swift"
15+
s.social_media_url = 'https://twitter.com/canopassoftware'
16+
17+
s.module_name = 'RichEditorSwiftUI'
18+
s.requires_arc = true
19+
s.swift_version = '5.5'
20+
21+
s.preserve_paths = 'README.md'
22+
23+
s.ios.deployment_target = '14.0'
24+
end

docs/index.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# RichEditorSwiftUI
2+
3+
iOS WYSIWYG Rich editor for SwiftUI.
4+
5+
<img src="./docs/sample.gif" height="640" />
6+
7+
## Features
8+
9+
The editor offers the following <b>options</b>:
10+
11+
- [x] **Bold**
12+
- [x] *Italic*
13+
- [x] <u>Underline</u>
14+
- [x] Different Heading
15+
16+
## How to add in your project
17+
18+
Add the dependency
19+
20+
```
21+
import XYZRichEditor
22+
```
23+
24+
## How to use ?
25+
26+
```
27+
struct EditorView: View {
28+
@ObservedObject var state: RichEditorState = .ini(input: "Hello World")
29+
30+
var body: some View {
31+
RichEditor(state: _state)
32+
.padding(10)
33+
}
34+
}
35+
```
36+
# Demo
37+
[Sample](https://github.com/canopas/rich-editor-swiftui/tree/main/RichEditorDemo) app demonstrates how simple the usage of the library actually is.
38+
39+
# Bugs and Feedback
40+
For bugs, questions and discussions please use the [Github Issues](https://github.com/canopas/rich-editor-swiftui/issues).
41+
42+
43+
## Credits
44+
RichEditor for SwiftUI is owned and maintained by the [Canopas team](https://canopas.com/). For project updates and releases, you can follow them on Twitter at [@canopassoftware](https://twitter.com/canopassoftware).
45+
46+
RichTextKit: https://github.com/danielsaidi/RichTextKit
47+

0 commit comments

Comments
 (0)