Fanu2 commited on
Commit
c74c980
Β·
1 Parent(s): e5e7320

Add basic README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -201
README.md CHANGED
@@ -1,206 +1,11 @@
1
- # ![Toast UI ImageEditor](https://user-images.githubusercontent.com/35218826/40895380-0b9f4cd6-67ea-11e8-982f-18121daa3a04.png)
2
 
3
- > Full featured image editor using HTML5 Canvas. It's easy to use and provides powerful filters.
4
 
5
- [![github version](https://img.shields.io/github/release/nhn/tui.image-editor.svg)](https://github.com/nhn/tui.image-editor/releases/latest)
6
- [![npm version](https://img.shields.io/npm/v/tui-image-editor.svg)](https://www.npmjs.com/package/tui-image-editor)
7
- [![license](https://img.shields.io/github/license/nhn/tui.image-editor.svg)](https://github.com/nhn/tui.image-editor/blob/master/LICENSE)
8
- [![PRs welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg)](https://github.com/nhn/tui.image-editor/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
9
- [![code with hearth by NHN Cloud](https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-NHN_CLOUD-ff1414.svg)](https://github.com/nhn)
10
- [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
11
 
12
- ## πŸ“¦ Packages
13
 
14
- - [toast-ui.image-editor](https://github.com/nhn/tui.image-editor/tree/master/apps/image-editor
15
- ) - Plain JavaScript component implemented by [NHN Cloud](https://github.com/nhn).
16
- - [toast-ui.vue-image-editor](https://github.com/nhn/tui.image-editor/tree/master/apps/vue-image-editor
17
- ) - **Vue** wrapper component is powered by [NHN Cloud](https://github.com/nhn).
18
- - [toast-ui.react-image-editor](https://github.com/nhn/tui.image-editor/tree/master/apps/react-image-editor
19
- ) - **React** wrapper component is powered by [NHN Cloud](https://github.com/nhn).
20
 
21
- ![6 -20-2018 17-45-54](https://user-images.githubusercontent.com/35218826/41647896-7b218ae0-74b2-11e8-90db-d7805cc23e8c.gif)
22
-
23
- ## 🚩 Table of Contents
24
-
25
- - [!Toast UI ImageEditor](#)
26
- - [πŸ“¦ Packages](#packages)
27
- - [🚩 Table of Contents](#-table-of-contents)
28
- - [🌏 Browser Support](#-browser-support)
29
- - [πŸ’ͺ Has full features that stick to the basic.](#-has-full-features-that-stick-to-the-basic)
30
- - [Photo manipulation](#photo-manipulation)
31
- - [Integration function](#integration-function)
32
- - [Powerful filter function](#powerful-filter-function)
33
- - [πŸ™† Easy to apply the size and design you want](#-easy-to-apply-the-size-and-design-you-want)
34
- - [Can be used everywhere.](#can-be-used-everywhere)
35
- - [Nice default & Fully customizable Themes](#nice-default--fully-customizable-themes)
36
- - [🎨 Features](#-features)
37
- - [πŸ”§ Pull Request Steps](#-pull-request-steps)
38
- - [Setup](#setup)
39
- - [Pull Request](#pull-request)
40
- - [πŸ“™ Documents](#-documents)
41
- - [πŸ’¬ Contributing](#-contributing)
42
- - [πŸ”© Dependency](#-dependency)
43
- - [🍞 TOAST UI Family](#-toast-ui-family)
44
- - [πŸš€ Used By](#-used-by)
45
- - [πŸ“œ License](#-license)
46
-
47
- ## 🌏 Browser Support
48
-
49
- | <img src="https://user-images.githubusercontent.com/1215767/34348387-a2e64588-ea4d-11e7-8267-a43365103afe.png" alt="Chrome" width="16px" height="16px" /> Chrome | <img src="https://user-images.githubusercontent.com/1215767/34348590-250b3ca2-ea4f-11e7-9efb-da953359321f.png" alt="IE" width="16px" height="16px" /> Internet Explorer | <img src="https://user-images.githubusercontent.com/1215767/34348380-93e77ae8-ea4d-11e7-8696-9a989ddbbbf5.png" alt="Edge" width="16px" height="16px" /> Edge | <img src="https://user-images.githubusercontent.com/1215767/34348394-a981f892-ea4d-11e7-9156-d128d58386b9.png" alt="Safari" width="16px" height="16px" /> Safari | <img src="https://user-images.githubusercontent.com/1215767/34348383-9e7ed492-ea4d-11e7-910c-03b39d52f496.png" alt="Firefox" width="16px" height="16px" /> Firefox |
50
- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------: |
51
- | Yes | 10+ | Yes | Yes | Yes |
52
-
53
- ## πŸ’ͺ Has full features that stick to the basic.
54
-
55
- ### Photo manipulation
56
-
57
- - Crop, Flip, Rotation, Drawing, Shape, Icon, Text, Mask Filter, Image Filter
58
-
59
- ### Integration function
60
-
61
- - Download, Image Load, Undo, Redo, Reset, Delete Object(Shape, Line, Mask Image...)
62
-
63
- <table>
64
- <tbody>
65
- <tr>
66
- <th width="20%">Crop</th>
67
- <th width="20%">Flip</th>
68
- <th width="20%">Rotation</th>
69
- <th width="20%">Drawing</th>
70
- <th width="20%">Shape</th>
71
- </tr>
72
- <tr>
73
- <td><img src="https://user-images.githubusercontent.com/35218826/40904241-0c28ec68-6815-11e8-8296-89a1716b22d8.png" alt="2018-06-04 4 33 16" style="max-width:100%;"></td>
74
- <td><img src="https://user-images.githubusercontent.com/35218826/40904521-f7c6e184-6815-11e8-8ba3-c94664da69a2.png" alt="2018-06-04 4 40 06" style="max-width:100%;"></td>
75
- <td><img src="https://user-images.githubusercontent.com/35218826/40904664-656aa748-6816-11e8-9943-6607c209deac.png" alt="2018-06-04 4 43 02" style="max-width:100%;"></td>
76
- <td><img src="https://user-images.githubusercontent.com/35218826/40904850-0f26ebde-6817-11e8-97d0-d3a7e4bc02da.png" alt="2018-06-04 4 47 40" style="max-width:100%;"></td>
77
- <td><img src="https://user-images.githubusercontent.com/35218826/40905037-a026296a-6817-11e8-9d28-9e1ca7bc58c4.png" alt="2018-06-04 4 51 45" style="max-width:100%;"></td>
78
- </tr>
79
- <tr>
80
- <th>Icon</th>
81
- <th>Text</th>
82
- <th>Mask</th>
83
- <th>Filter</th>
84
- <th></th>
85
- </tr>
86
- <tr>
87
- <td><img src="https://user-images.githubusercontent.com/35218826/40931205-2d255db6-6865-11e8-98af-ad34c5a01da1.png" alt="2018-06-05 2 06 29" style="max-width:100%;"></td>
88
- <td><img src="https://user-images.githubusercontent.com/35218826/40931484-46253948-6866-11e8-8a04-fa042920e457.png" alt="2018-06-05 2 14 36" style="max-width:100%;"></td>
89
- <td><img src="https://user-images.githubusercontent.com/35218826/40931743-21eeb346-6867-11e8-8e31-a59f7a43482b.png" alt="2018-06-05 2 20 46" style="max-width:100%;"></td>
90
- <td><img src="https://user-images.githubusercontent.com/35218826/40932016-093ed1f4-6868-11e8-8224-a048c3ee8a09.png" alt="2018-06-05 2 27 10" style="max-width:100%;"></td>
91
- <td></td>
92
- </tr>
93
- </tbody>
94
- </table>
95
-
96
- ### Powerful filter function
97
-
98
- - Grayscale, Invert, Sepia, Blur Sharpen, Emboss, RemoveWhite, Brightness, Noise, Pixelate, ColorFilter, Tint, Multiply, Blend
99
-
100
- | Grayscale | Noise | Emboss | Pixelate |
101
- | ------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
102
- | ![grayscale](https://user-images.githubusercontent.com/35218826/41753470-930fb7b0-7608-11e8-9966-1c890e73d131.png) | ![noise](https://user-images.githubusercontent.com/35218826/41753458-9013bc82-7608-11e8-91d9-74dcc3ffce31.png) | ![emboss](https://user-images.githubusercontent.com/35218826/41753460-906c018a-7608-11e8-8861-c135c0117cea.png) | ![pixelate](https://user-images.githubusercontent.com/35218826/41753461-90a614a6-7608-11e8-97a7-0d3b7bb4aec4.png) |
103
-
104
- | Sepia | Sepia2 | Blend-righten | Blend-diff | Invert |
105
- | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
106
- | ![sepia](https://user-images.githubusercontent.com/35218826/41753464-91acc41c-7608-11e8-8652-572f935ea704.png) | ![sepia2](https://user-images.githubusercontent.com/35218826/41753640-91e57248-7609-11e8-8960-145e0de57e39.png) | ![blend-righten](https://user-images.githubusercontent.com/35218826/41753462-9114bc3a-7608-11e8-9ab4-16ce20a34321.png) | ![blend-diff](https://user-images.githubusercontent.com/35218826/41753465-91e4baf2-7608-11e8-9b8f-79e1b956d387.png) | ![invert](https://user-images.githubusercontent.com/35218826/41753466-9260b224-7608-11e8-848a-73231a02ae3a.png) |
107
-
108
- | Multifly | Tint | Brightness | Remove-white | Sharpen |
109
- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
110
- | ![multifly](https://user-images.githubusercontent.com/35218826/41753467-92baae28-7608-11e8-80d2-187a310213f5.png) | ![tint](https://user-images.githubusercontent.com/35218826/41753468-92e6391c-7608-11e8-8977-651366ebe693.png) | ![brightness](https://user-images.githubusercontent.com/35218826/41753457-8fb3d3c6-7608-11e8-9e1d-10c6e4aeba68.png) | ![remove-white](https://user-images.githubusercontent.com/35218826/41753463-917feeb0-7608-11e8-862d-eb3af84e120a.png) | ![sharpen](https://user-images.githubusercontent.com/35218826/41753639-91b8470a-7609-11e8-8d13-48ac3232365b.png) |
111
-
112
- ## πŸ™† Easy to apply the size and design you want
113
-
114
- ### Can be used everywhere.
115
-
116
- - Widely supported in browsers including IE10.
117
- - Option to support various display sizes.
118
- (allows you to use the editor features on your web pages at least over **550 \* 450 sizes**)
119
-
120
- ![2018-06-04 5 35 25](https://user-images.githubusercontent.com/35218826/40907369-9221f482-681e-11e8-801c-78d6f2e246a8.png)
121
-
122
- ### Nice default & Fully customizable Themes
123
-
124
- - Has a white and black theme, and you can modify the theme file to customize it.
125
- - Has an API so that you can create your own instead of the built-in.
126
-
127
- | black - top | black - bottom | white - left | white - right |
128
- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
129
- | ![2018-06-05 1 41 13](https://user-images.githubusercontent.com/35218826/40930753-8b72502e-6863-11e8-9cff-1719aee9aef0.png) | ![2018-06-05 1 40 24](https://user-images.githubusercontent.com/35218826/40930755-8bcee136-6863-11e8-8e28-0a6722d38c59.png) | ![2018-06-05 1 41 48](https://user-images.githubusercontent.com/35218826/40930756-8bfe0b50-6863-11e8-8682-bab11a0a2289.png) | ![2018-06-05 1 42 27](https://user-images.githubusercontent.com/35218826/40930754-8ba1dba0-6863-11e8-9439-cc059241b675.png) |
130
-
131
- ## 🎨 Features
132
-
133
- - Load image to canvas
134
- - Undo/Redo (With shortcut)
135
- - Crop
136
- - Flip
137
- - Rotation
138
- - Resize
139
- - Free drawing
140
- - Line drawing
141
- - Shape
142
- - Icon
143
- - Text
144
- - Mask Filter
145
- - Image Filter
146
-
147
- ## πŸ”§ Pull Request Steps
148
-
149
- TOAST UI products are open source, so you can create a pull request(PR) after you fix issues.
150
- Run npm scripts and develop yourself with the following process.
151
-
152
- ### Setup
153
-
154
- Fork `develop` branch into your personal repository.
155
- Clone it to local computer. Install node modules.
156
- Before starting development, you should check if there are any errors.
157
-
158
- ```sh
159
- $ git clone https://github.com/{your-personal-repo}/[[repo name]].git
160
- $ cd [[repo name]]
161
- $ npm install
162
- ```
163
-
164
- ### Pull Request
165
-
166
- Before uploading your PR, run test one last time to check if there are any errors.
167
- If it has no errors, commit and then push it!
168
-
169
- For more information on PR's steps, please see links in the Contributing section.
170
-
171
- ## πŸ“™ Documents
172
-
173
- - [Getting Started](https://github.com/nhn/tui.image-editor/tree/master/docs/Basic-Tutorial.md)
174
- - [Tutorial](https://github.com/nhn/tui.image-editor/tree/master/docs)
175
- - [Example](http://nhn.github.io/tui.image-editor/latest/tutorial-example01-includeUi)
176
- - [API](http://nhn.github.io/tui.image-editor/latest)
177
-
178
- ## πŸ’¬ Contributing
179
-
180
- - [Code of Conduct](https://github.com/nhn/tui.image-editor/blob/master/CODE_OF_CONDUCT.md)
181
- - [Contributing guideline](https://github.com/nhn/tui.image-editor/blob/master/CONTRIBUTING.md)
182
- - [Issue guideline](https://github.com/nhn/tui.image-editor/blob/master/ISSUE_TEMPLATE.md)
183
- - [Commit convention](https://github.com/nhn/tui.image-editor/blob/production/docs/COMMIT_MESSAGE_CONVENTION.md)
184
-
185
- ## πŸ”© Dependency
186
-
187
- - [fabric.js](https://github.com/fabricjs/fabric.js/releases) = 4.2.0
188
- - [tui.code-snippet](https://github.com/nhn/tui.code-snippet/releases/tag/v1.5.0) >= 1.5.0
189
- - [tui.color-picker](https://github.com/nhn/tui.color-picker/releases/tag/v2.2.6) >= 2.2.6
190
-
191
- ## 🍞 TOAST UI Family
192
-
193
- - [TOAST UI Editor](https://github.com/nhn/tui.editor)
194
- - [TOAST UI Grid](https://github.com/nhn/tui.grid)
195
- - [TOAST UI Chart](https://github.com/nhn/tui.chart)
196
- - [TOAST UI Calendar](https://github.com/nhn/tui.calendar)
197
- - [TOAST UI Components](https://github.com/nhn)
198
-
199
- ## πŸš€ Used By
200
-
201
- - [NHN Dooray! - Collaboration Service (Project, Messenger, Mail, Calendar, Drive, Wiki, Contacts)](https://dooray.com/home/)
202
- - [Catalyst](https://catalystapp.co/)
203
-
204
- ## πŸ“œ License
205
-
206
- [MIT LICENSE](https://github.com/nhn/tui.image-editor/blob/master/LICENSE)
 
1
+ # Toast Image Editor
2
 
3
+ Simple, easy-to-use image editor built with Huggingface Spaces.
4
 
5
+ ## Usage
 
 
 
 
 
6
 
7
+ Run `app.py` to start the application.
8
 
9
+ ## License
 
 
 
 
 
10
 
11
+ MIT License