From 567cd0b60bd0050bb5c73896d56ce7add7242f0c Mon Sep 17 00:00:00 2001
From: Ankit Mahato <ankmahato@gmail.com>
Date: Sat, 13 May 2023 10:51:34 +0530
Subject: [PATCH] Update README.md
---
README.md | 110 +++++++++++++++++++-----------------------------------
1 file changed, 38 insertions(+), 72 deletions(-)
diff --git a/README.md b/README.md
index e0b7eeee..13cf4696 100644
--- a/README.md
+++ b/README.md
@@ -6,8 +6,6 @@
API Dash is a beautiful open-source cross-platform API Client that can help you easily create & customize your API requests, visually inspect responses and generate Dart code on the go.
-
-
## Download
API Dash can be downloaded from the links below:
@@ -60,6 +58,44 @@ API Dash can be downloaded from the links below:
</tbody>
</table>
+## A Quick Glimpse into API Dash ⚡️ (Demo Video)
+
+https://github.com/foss42/api-dash/assets/615622/fccc569e-3152-47be-9f94-ceb851ee85a0
+
+## List of Features
+
+**↗️ Create & Customize API Requests**
+- Create different types of HTTP requests (`GET`, `HEAD`, `POST`, `PATCH`, `PUT` and `DELETE`)
+- Easily manipulate and play around with request inputs like `headers`, `query parameters` and `body`.
+- Full support to send text content with 🥳 Unicode/Emoji and preview any API response containing Unicode/Emoji.
+
+**🔎 Visually Inspect and Download API Responses**
+- Inspect the API Response (HTTP status code, error message, headers, body, time taken)
+- View formatted code previews for responses of various content types like `JSON`, `XML`, `YAML`, `HTML`, `SQL`, etc.
+- Supports directly previewing these a wide variety of 🖼 image file formats such as `jpeg`, `png`, `gif`, etc.
+- Save 💾 response body of any mimetype (`image`, `text`, etc.) directly in the `Downloads` folder of your system by clicking on the `Download` button.
+
+**👩🏻💻 Code Generation**
+- The **only** open source API client that supports advanced Dart code generation so that you can easily integrate APIs in your Dart/Flutter project or directly run it on DartPad.
+
+**🌙 Full Dark Mode Support**
+- Easily switch between light mode and dark mode.
+
+**💼 Organize Requests in Collection Pane**
+- Press and Drag to Re-arrange requests.
+- Double-click to rename requests.
+- Click and open popup menu to duplicate and delete a request.
+
+**💾 Data**
+- Data is persisted locally on the disk. To save the current snapshot, just press the **Save** button in the collection pane.
+
+**⚙️ Settings & Other Options**
+- Customize various options using a dedicated Settings screen.
+- Window Configuration (Size & Position) is persisted and restored on app start. (Only macOS & Windows)
+
+## What's new in v0.2.0?
+
+Visit [CHANGELOG.md](CHANGELOG.md)
## Provide Feedback, Report Bugs & Request New Features
@@ -71,76 +107,6 @@ You can get started with some ["good first issues"](https://github.com/foss42/ap
Also, check out [CONTRIBUTING.md](CONTRIBUTING.md)
-## What's new in v0.2.0?
-
-### 1. Brand new UI
-
-We have revamped the UI to provide a better user experience along with a new settings screen.
-
-https://user-images.githubusercontent.com/615622/236214993-e7818697-4f1d-4759-9a66-66e5ed64fa58.mp4
-
-### 2. Dark Mode Support
-
-https://user-images.githubusercontent.com/615622/236202915-fbeeca4e-5108-41da-858a-1b7ba2b4f579.mov
-
-### 3. Emoji support
-
-You can now easily send text content with emojis and preview any API response containing emojis.
-
-
-
-### 4. Rename any request
-
-Just double-click on it and enter the name.
-
-https://user-images.githubusercontent.com/615622/236203140-54088e4f-84ec-4280-b4cd-334eb7b549e1.mov
-
-### 5. Save response body of any mimetype
-
-You can now save response body of any mimetype (image, text, etc.) directly in the Downloads folder by clicking on the Download button.
-
-<p align="center">
-<img width="516" alt="light-download" src="https://user-images.githubusercontent.com/615622/236203401-754da8d1-291f-492d-b870-eb1fb36372f7.png">
-</p>
-
-6. Window size and position is persisted and the configuration is restored on app start. (Only macOS & Windows)
-7. Notification on save, download and any other user action (UX improvement).
-8. Linux builds are now available for API Dash (.deb & .rpm).
-
-## Features of API Dash
-
-### 1. Create & Customize API Requests
-Using API Dash, you can draft API requests via an easy to use GUI which allows you to:
-- Create different types of HTTP requests (GET, HEAD, POST, PATCH, PUT and DELETE)
-- Easily manipulate and play around with request inputs like headers, query parameters and body.
-
-**Feature Preview (Video)👇**
-
-https://user-images.githubusercontent.com/1382619/227081895-22af076f-469c-4f70-86e6-3dda8beccd31.mp4
-
-### 2. Visually inspect API Responses
-Using API Dash, you can:
-- Inspect the API Response (HTTP status code, error message, headers, body, time taken)
-- View formatted code previews for responses of various content types like JSON, XML, YAML, HTML, SQL, etc.
-- For APIs which return results as images, API Dash helps you save a lot of time by directly previewing these results and supports a wide variety of image file formats such as jpeg, png, gif, etc.
-
-**Feature Preview (Video)👇**
-
-https://user-images.githubusercontent.com/1382619/227082005-7b374f5a-c406-4963-8f97-71fda4a58f69.mp4
-
-### 3. Generate Dart Code Automatically
-API Dash is the **only** open source API client that supports advanced Dart code generation so that you can easily integrate APIs in your Dart/Flutter project.
-For each request, you can click on **View Code** to directly view the corresponding Dart code which you can then *Copy* and directly run it on DartPad.
-
-**Feature Preview (Video)👇**
-
-https://user-images.githubusercontent.com/1382619/227082072-2c829996-2550-425d-ad73-e81f96d2d270.mp4
-
-## Other Features
-
-- All user data is persisted locally on the disk. To save the current snapshot, just press the **Save** button in the collection pane.
-- You can also re-arrange (press and drag), duplicate and delete the API drafts.
-
## Need Any Help?
In case you need any help with API Dash or are encountering any issue while running the tool, please feel free to drop by our [Discord server](https://bit.ly/heyfoss) and we can have a chat in the **#foss** channel.