From b0ce545116ffd0b7906d7601337eb888e2959277 Mon Sep 17 00:00:00 2001 From: Zero Date: Wed, 17 Feb 2021 19:33:07 +0800 Subject: [PATCH 01/10] Update README.md simplify rep README --- README.md | 30 +++--------------------------- 1 file changed, 3 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index f0c08d8a0..9c1ae2583 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at be Remember to star it, flow will love you more :) ## Features + ![The Flow](https://user-images.githubusercontent.com/26427004/82151677-fa9c7100-989f-11ea-9143-81de60aaf07d.gif) - Search everything from applications, files, bookmarks, YouTube, Twitter and more. All from the comfort of your keyboard without ever touching the mouse. @@ -26,31 +27,6 @@ Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at be - Support of wide range of plugins. - Fully portable. -## Running Flow Launcher - -| [Windows 7 and up](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest) | -| ---------------------------------------------------------------------------------- | - -Windows may complain about security due to code not being signed, this will be completed at a later stage. If you downloaded from this repo, you are good to continue the set up. - -**Integrations** - - If you use Python plugins: - - Install [Python3](https://www.python.org/downloads/), download `.exe` installer. - - Add Python to `%PATH%` or set it in flow's settings. - - Use `pip` to install `flowlauncher`, cmd in `pip install flowlauncher`. - - Start to launch your Python plugins. - - Flow searches files and contents via Windows Index Search, to use Everything, download the plugin [here](https://github.com/Flow-Launcher/Flow.Launcher.Plugin.Everything/releases/latest). - -**Usage** -- Open flow's search window: Alt+Space is the default hotkey. -- Open context menu: Ctrl+O/Shift+Enter. -- Cancel/Return to previous screen: Esc. -- Install/Uninstall plugins: in the search window, type `wpm install/uninstall` + the plugin name. -- Saved user settings are located: - - If using roaming: `%APPDATA%\FlowLauncher` - - If using portable, by default: `%localappdata%\FlowLauncher\app-\UserData` -- Logs are saved along with your user settings folder - ## Status Flow is under heavy development, but the code base is stable, so contributions are very welcome. If you would like to help maintain it, please do not hesistate to get in touch. @@ -63,7 +39,7 @@ You will find the main goals of flow placed under Projects board, so feel free t Get in touch if you like to join the Flow-Launcher Team and help build this great tool. -**Question/Suggestion** +## Question/Suggestion Yes please, submit an issue to let us know. @@ -79,4 +55,4 @@ Install .Net Core 3.1 SDK via Visual Studio installer or manually from [here](ht ## Documentation -[Wiki](https://github.com/Flow-Launcher/Flow.Launcher/wiki) +https://flow-launcher.github.io/docs From ed82662da2b0d625e83199945890ed2394e1a915 Mon Sep 17 00:00:00 2001 From: Zero Date: Thu, 18 Feb 2021 22:00:06 +0800 Subject: [PATCH 02/10] Update README.md --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index 5fad0367b..8c652593c 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,33 @@ Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at be - Save file or folder locations for quick access. - Fully portable. +## Running Flow Launcher + +| [Windows 7 and up](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest) | +| ---------------------------------------------------------------------------------- | + +Windows may complain about security due to code not being signed, this will be completed at a later stage. If you downloaded from this repo, you are good to continue the set up. + +### Integrations + +- If you use Python plugins: + - Install [Python3](https://www.python.org/downloads/), download `.exe` installer. + - Add Python to `%PATH%` or set it in flow's settings. + - Use `pip` to install `flowlauncher`, cmd in `pip install flowlauncher`. + - Start to launch your Python plugins. +- Flow searches files and contents via Windows Index Search, to use Everything, download the plugin [here](https://github.com/Flow-Launcher/Flow.Launcher.Plugin.Everything/releases/latest). + +### Usage + +- Open flow's search window: Alt+Space is the default hotkey. +- Open context menu: Ctrl+O/Shift+Enter. +- Cancel/Return to previous screen: Esc. +- Install/Uninstall plugins: in the search window, type `wpm install/uninstall` + the plugin name. +- Saved user settings are located: + - If using roaming: `%APPDATA%\FlowLauncher` + - If using portable, by default: `%localappdata%\FlowLauncher\app-\UserData` +- Logs are saved along with your user settings folder + ## Status Flow is under heavy development, but the code base is stable, so contributions are very welcome. If you would like to help maintain it, please do not hesistate to get in touch. From 43f48de2a3444159aae2da75d6a0c3437da9baef Mon Sep 17 00:00:00 2001 From: Zero Date: Thu, 18 Feb 2021 22:04:25 +0800 Subject: [PATCH 03/10] Update README.md missing SOFTPEDIA EDITOR'S PICK --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 8c652593c..9d52d268a 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,8 @@ Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at be - Save file or folder locations for quick access. - Fully portable. +[ **SOFTPEDIA EDITOR'S PICK**](https://www.softpedia.com/get/System/Launchers-Shutdown-Tools/Flow-Launcher.shtml) + ## Running Flow Launcher | [Windows 7 and up](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest) | From 81f069d8d20f5a0bc50c4f5b1591fbd6880fb3cb Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Fri, 19 Feb 2021 07:33:50 +1100 Subject: [PATCH 04/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9d52d268a..64fe90d50 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ Windows may complain about security due to code not being signed, this will be c - Open flow's search window: Alt+Space is the default hotkey. - Open context menu: Ctrl+O/Shift+Enter. - Cancel/Return to previous screen: Esc. -- Install/Uninstall plugins: in the search window, type `wpm install/uninstall` + the plugin name. +- Install/Uninstall plugins: in the search window, type `pm install/uninstall` + the plugin name. - Saved user settings are located: - If using roaming: `%APPDATA%\FlowLauncher` - If using portable, by default: `%localappdata%\FlowLauncher\app-\UserData` From 926f8362f2bb8200f2c15c5884128ca4b6fa4ed9 Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Fri, 19 Feb 2021 08:01:54 +1100 Subject: [PATCH 05/10] Update README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 64fe90d50..9e89053b5 100644 --- a/README.md +++ b/README.md @@ -39,25 +39,25 @@ Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at be Windows may complain about security due to code not being signed, this will be completed at a later stage. If you downloaded from this repo, you are good to continue the set up. ### Integrations - -- If you use Python plugins: - - Install [Python3](https://www.python.org/downloads/), download `.exe` installer. - - Add Python to `%PATH%` or set it in flow's settings. - - Use `pip` to install `flowlauncher`, cmd in `pip install flowlauncher`. - - Start to launch your Python plugins. -- Flow searches files and contents via Windows Index Search, to use Everything, download the plugin [here](https://github.com/Flow-Launcher/Flow.Launcher.Plugin.Everything/releases/latest). + - If you use Python plugins: + - Install [Python3](https://www.python.org/downloads/), download `.exe` installer. + - Add Python to `%PATH%` or set it in flow's settings. + - Use `pip` to install `flowlauncher`, cmd in `pip install flowlauncher`. + - Start to launch your Python plugins. + - Flow searches files and contents via Windows Index Search, to use Everything, download the plugin [here](https://github.com/Flow-Launcher/Flow.Launcher.Plugin.Everything/releases/latest). ### Usage - - Open flow's search window: Alt+Space is the default hotkey. -- Open context menu: Ctrl+O/Shift+Enter. +- Open context menu: on the selected result, press Ctrl+O/Shift+Enter. - Cancel/Return to previous screen: Esc. -- Install/Uninstall plugins: in the search window, type `pm install/uninstall` + the plugin name. +- Install/Uninstall/Update plugins: in the search window, type `pm` `install`/`uninstall`/`update` + the plugin name. - Saved user settings are located: - If using roaming: `%APPDATA%\FlowLauncher` - If using portable, by default: `%localappdata%\FlowLauncher\app-\UserData` - Logs are saved along with your user settings folder +[More tips](https://flow-launcher.github.io/docs/#/usage-tips) + ## Status Flow is under heavy development, but the code base is stable, so contributions are very welcome. If you would like to help maintain it, please do not hesistate to get in touch. From 95da58534318f7f85ad3c8f82301c77bb0f3de4d Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Fri, 19 Feb 2021 08:44:36 +1100 Subject: [PATCH 06/10] add documentation badge --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9e89053b5..a0ed2d5e8 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,12 @@

-![Maintenance](https://img.shields.io/maintenance/yes/2021) +![Maintenance](https://img.shields.io/maintenance/yes/3000) [![Build status](https://ci.appveyor.com/api/projects/status/32r7s2skrgm9ubva?svg=true&retina=true)](https://ci.appveyor.com/project/JohnTheGr8/flow-launcher/branch/dev) [![Github All Releases](https://img.shields.io/github/downloads/Flow-Launcher/Flow.Launcher/total.svg)](https://github.com/Flow-Launcher/Flow.Launcher/releases) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/Flow-Launcher/Flow.Launcher)](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest) ![GitHub Release Date](https://img.shields.io/github/release-date/Flow-Launcher/Flow.Launcher) +[![Documentation](https://img.shields.io/badge/Documentation-blue)](https://flow-launcher.github.io/docs) [![Discord](https://img.shields.io/discord/727828229250875472?color=7389D8&labelColor=6A7EC2&label=Community&logo=discord&logoColor=white)](https://discord.gg/AvgAQgh) Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at being more than an app launcher, it searches, integrates and expands on functionalities. Flow will continue to evolve, designed to be open and built with the community at heart. From 8b81ac004aa623e1f4a71120e02f4772573eae81 Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Fri, 19 Feb 2021 08:46:56 +1100 Subject: [PATCH 07/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a0ed2d5e8..6bc6182dc 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ [![Github All Releases](https://img.shields.io/github/downloads/Flow-Launcher/Flow.Launcher/total.svg)](https://github.com/Flow-Launcher/Flow.Launcher/releases) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/Flow-Launcher/Flow.Launcher)](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest) ![GitHub Release Date](https://img.shields.io/github/release-date/Flow-Launcher/Flow.Launcher) -[![Documentation](https://img.shields.io/badge/Documentation-blue)](https://flow-launcher.github.io/docs) +[![Documentation](https://img.shields.io/badge/Documentation-7389D8)](https://flow-launcher.github.io/docs) [![Discord](https://img.shields.io/discord/727828229250875472?color=7389D8&labelColor=6A7EC2&label=Community&logo=discord&logoColor=white)](https://discord.gg/AvgAQgh) Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at being more than an app launcher, it searches, integrates and expands on functionalities. Flow will continue to evolve, designed to be open and built with the community at heart. From b2ae8d08c273e0fc25bb57e7232c7d6052ce8d86 Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Fri, 19 Feb 2021 08:55:11 +1100 Subject: [PATCH 08/10] add contributors badge --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6bc6182dc..6d7984520 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,9 @@ ![Maintenance](https://img.shields.io/maintenance/yes/3000) [![Build status](https://ci.appveyor.com/api/projects/status/32r7s2skrgm9ubva?svg=true&retina=true)](https://ci.appveyor.com/project/JohnTheGr8/flow-launcher/branch/dev) [![Github All Releases](https://img.shields.io/github/downloads/Flow-Launcher/Flow.Launcher/total.svg)](https://github.com/Flow-Launcher/Flow.Launcher/releases) -[![GitHub release (latest by date)](https://img.shields.io/github/v/release/Flow-Launcher/Flow.Launcher)](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest) ![GitHub Release Date](https://img.shields.io/github/release-date/Flow-Launcher/Flow.Launcher) +[![GitHub release (latest by date)](https://img.shields.io/github/v/release/Flow-Launcher/Flow.Launcher)](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest) +![Contributors](https://badgen.net/github/contributors/Flow-Launcher/Flow.Launcher) [![Documentation](https://img.shields.io/badge/Documentation-7389D8)](https://flow-launcher.github.io/docs) [![Discord](https://img.shields.io/discord/727828229250875472?color=7389D8&labelColor=6A7EC2&label=Community&logo=discord&logoColor=white)](https://discord.gg/AvgAQgh) From 7b22622285cd8a1a28efc60cbeacc232c912d263 Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Fri, 19 Feb 2021 08:58:18 +1100 Subject: [PATCH 09/10] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 6d7984520..ad3050885 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ Windows may complain about security due to code not being signed, this will be c - Install [Python3](https://www.python.org/downloads/), download `.exe` installer. - Add Python to `%PATH%` or set it in flow's settings. - Use `pip` to install `flowlauncher`, cmd in `pip install flowlauncher`. + - The Python plugin may require additional modules to be installed, please ensure you check by visiting the plugin's website via `pm install` + plugin name, go to context menu and select `Open website`. - Start to launch your Python plugins. - Flow searches files and contents via Windows Index Search, to use Everything, download the plugin [here](https://github.com/Flow-Launcher/Flow.Launcher.Plugin.Everything/releases/latest). From bb42b930e367f7547cdabcdd7350b929cc88b546 Mon Sep 17 00:00:00 2001 From: Jeremy Wu Date: Fri, 19 Feb 2021 08:59:11 +1100 Subject: [PATCH 10/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ad3050885..f1647fc7f 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ Windows may complain about security due to code not being signed, this will be c - If you use Python plugins: - Install [Python3](https://www.python.org/downloads/), download `.exe` installer. - Add Python to `%PATH%` or set it in flow's settings. - - Use `pip` to install `flowlauncher`, cmd in `pip install flowlauncher`. + - Use `pip` to install `flowlauncher`, open cmd and type `pip install flowlauncher`. - The Python plugin may require additional modules to be installed, please ensure you check by visiting the plugin's website via `pm install` + plugin name, go to context menu and select `Open website`. - Start to launch your Python plugins. - Flow searches files and contents via Windows Index Search, to use Everything, download the plugin [here](https://github.com/Flow-Launcher/Flow.Launcher.Plugin.Everything/releases/latest).