Skip to content

Commit 03ea728

Browse files
authored
Updated read me (#9)
* Updated read me * Added sample gif
1 parent ef47ee4 commit 03ea728

File tree

2 files changed

+63
-0
lines changed

2 files changed

+63
-0
lines changed

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,64 @@
11
# 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+
48+
# Licence
49+
50+
```
51+
Copyright 2023 Canopas Software LLP
52+
53+
Licensed under the Apache License, Version 2.0 (the "License");
54+
You won't be using this file except in compliance with the License.
55+
You may obtain a copy of the License at
56+
57+
http://www.apache.org/licenses/LICENSE-2.0
58+
59+
Unless required by applicable law or agreed to in writing, software
60+
distributed under the License is distributed on an "AS IS" BASIS,
61+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
62+
See the License for the specific language governing permissions and
63+
limitations under the License.
64+
```

docs/sample.gif

4.42 MB
Loading

0 commit comments

Comments
 (0)