Skip to content

Commit 3f170fb

Browse files
committed
#1 add intro GIF. ref: #2 (comment)
1 parent 606d6c8 commit 3f170fb

File tree

1 file changed

+30
-21
lines changed

1 file changed

+30
-21
lines changed

README.md

+30-21
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,30 @@
11
<div align="center">
22

3-
# `Flutter` `WYSIWYG` editor tutorial
3+
# `Flutter` `WYSIWYG` Editor Tutorial
44

5-
📱 📝 How to do WYSIWYG editing in Flutter in a few easy steps.
5+
📱 📝 How to do WYSIWYG ("What You See Is What You Get") editing
6+
in `Flutter` in a few easy steps.
67

78
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/dwyl/flutter-wysiwyg-editor-tutorial/ci.yml?label=build&style=flat-square&branch=main)
89
[![codecov.io](https://img.shields.io/codecov/c/github/dwyl/flutter-wysiwyg-editor-tutorial/master.svg?style=flat-square)](https://codecov.io/github/dwyl/flutter-wysiwyg-editor-tutorial?branch=master)
910
[![HitCount](https://hits.dwyl.com/dwyl/flutter-wysiwyg-editor-tutorial.svg?style=flat-square&show=unique)](https://hits.dwyl.com/dwyl/flutter-wysiwyg-editor-tutorial)
1011
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat-square)](https://github.com/dwyl/flutter-wysiwyg-editor-tutorial/issues)
1112

1213

14+
![dwyl-wysiwyg-demo-optimized](https://github.com/dwyl/flutter-wysiwyg-editor-tutorial/assets/194400/08c6daff-33be-4f1a-9077-012cfd52b72c)
15+
16+
1317
</div>
1418
<br />
1519

16-
- [`Flutter` `WYSIWYG` editor tutorial](#flutter-wysiwyg-editor-tutorial)
20+
- [`Flutter` `WYSIWYG` Editor Tutorial](#flutter-wysiwyg-editor-tutorial)
1721
- [Why? 🤷‍](#why-)
1822
- [What? 💭](#what-)
1923
- [Who? 👤](#who-)
2024
- [_How_? 👩‍💻](#how-)
2125
- [Prerequisites? 📝](#prerequisites-)
2226
- [0. Project setup](#0-project-setup)
23-
- [\*\*Make sure your `flutter` is up-to-date!](#make-sure-your-flutter-is-up-to-date)
27+
- [Make sure your `Flutter` is up-to-date!](#make-sure-your-flutter-is-up-to-date)
2428
- [1. Installing all the needed dependencies](#1-installing-all-the-needed-dependencies)
2529
- [2. Setting up the responsive framework](#2-setting-up-the-responsive-framework)
2630
- [3. Create `HomePage` with basic editor](#3-create-homepage-with-basic-editor)
@@ -39,12 +43,18 @@
3943

4044
# Why? 🤷‍
4145

42-
On our [`app`](https://github.com/dwyl/app),
43-
people will add their todo items.
44-
To do so, they *need* a capable editor
45-
that is easy-to-use that also supports
46-
customization
47-
(new buttons).
46+
Our
47+
[`app`](https://github.com/dwyl/app),
48+
allows `people` to add `items` of `text`
49+
which get _transformed_ into several types of `list`.
50+
e.g: `Todo List`, `Shopping List`, `Exercises`, etc.
51+
We *need* a capable editor
52+
that is easy-to-use
53+
and supports customization
54+
(new buttons)
55+
to allow them to _easily_
56+
transform their `plaintext` into `richtext`
57+
e.g: headings, bold, highlights, links and images!
4858

4959
# What? 💭
5060

@@ -54,8 +64,8 @@ to their heart's content
5464
and customize it to their liking.
5565

5666
This repo will showcase an introduction
57-
of a `WYSIWYG` Rich Text editor
58-
that can be used on both mobile and web devices.
67+
of a `WYSIWYG` Rich Text Editor
68+
that can be used on both `Mobile` and `Web`.
5969
We want this editor to be *extensible*,
6070
meaning that we want to add specific features
6171
and *introduce them* to the person
@@ -68,13 +78,12 @@ This quick demo is aimed at people in the @dwyl team
6878
or anyone who is interested in learning
6979
more about building a `WYSIWYG` editor.
7080

71-
> [!WARNING]
72-
>
73-
> Do take note that this guide is meant
74-
> **only for `mobile devices` and `web apps`**.
75-
> It is **not** tailored to Flutter desktop applications.
76-
> We'll be focusing on the web and mobile devices
77-
> because it's more important *to us*
81+
> **Note**: this guide is meant
82+
> **only for `Mobile` devices and `Web` Apps**.
83+
> It is ***not*** tailored to **`Desktop` apps**.
84+
> We are focusing on the `Web` and `Mobile` devices
85+
> because it's
86+
> [more important *to us*](https://github.com/dwyl/learn-flutter#mac-focussed-)
7887
> and because it's simpler to understand.
7988
> Some implementation details will need to be changed
8089
> if you want this to work on desktop applications.
@@ -91,7 +100,7 @@ more about building a `WYSIWYG` editor.
91100
This demo assumes you have foundational knowledge of `Flutter`.
92101
If this is your first time tinkering with `Flutter`,
93102
we suggest you first take a look at
94-
https://github.com/dwyl/learn-flutter.
103+
[dwyl/learn-flutter](https://github.com/dwyl/learn-flutter)
95104

96105
In the linked repo, you will learn
97106
how to install the needed dependencies
@@ -120,7 +129,7 @@ this output on the terminal.
120129
This means everything is correctly set up!
121130
We are ready to start implementing!
122131

123-
### Make sure your `flutter` is up-to-date!
132+
### Make sure your `Flutter` is up-to-date!
124133

125134
Make sure you are running the latest version of `Flutter`!
126135
You can make a run-through of the versions by running:

0 commit comments

Comments
 (0)