Skip to content

Commit a9844fd

Browse files
authored
Update readme (#865)
updated readme
1 parent 037e0f8 commit a9844fd

File tree

2 files changed

+221
-49
lines changed

2 files changed

+221
-49
lines changed

Flow.Launcher/SettingWindow.xaml.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,4 +371,4 @@ private void Window_StateChanged(object sender, EventArgs e)
371371
}
372372

373373
}
374-
}
374+
}

README.md

Lines changed: 220 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,86 +1,258 @@
11
<p align="center">
2+
<img src="https://user-images.githubusercontent.com/6903107/144854670-d624d717-d86a-49e5-a5e5-e782f91ed12a.png" width="300"><br />
23
<a href="https://flow-launcher.github.io">
3-
<img width="500px" src="https://github.com/Flow-Launcher/Flow.Launcher/blob/5ba4514f31e624c679628d4dfe89036c0e24006c/Doc/Logo/resources/flow-header-square-transparent.png">
4+
<img src="https://user-images.githubusercontent.com/6903107/144854052-969f5e60-a0ec-44b8-8968-620467496f10.gif" width="500">
45
</a>
56
</p>
7+
<br />
68

7-
![Maintenance](https://img.shields.io/maintenance/yes/3000)
8-
[![Build status](https://ci.appveyor.com/api/projects/status/32r7s2skrgm9ubva?svg=true&retina=true)](https://ci.appveyor.com/project/JohnTheGr8/flow-launcher/branch/dev)
9-
[![Github All Releases](https://img.shields.io/github/downloads/Flow-Launcher/Flow.Launcher/total.svg)](https://github.com/Flow-Launcher/Flow.Launcher/releases)
10-
![GitHub Release Date](https://img.shields.io/github/release-date/Flow-Launcher/Flow.Launcher)
11-
[![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)
12-
[![Documentation](https://img.shields.io/badge/Documentation-7389D8)](https://flow-launcher.github.io/docs)
13-
[![Discord](https://img.shields.io/discord/727828229250875472?color=7389D8&labelColor=6A7EC2&label=Community&logo=discord&logoColor=white)](https://discord.gg/AvgAQgh)
9+
<p align="center">
10+
<img src="https://img.shields.io/maintenance/yes/3000">
11+
<a href="https://crowdin.com/project/flow-launcher"><img src="https://badges.crowdin.net/flow-launcher/localized.svg"></a>
12+
<a href="https://ci.appveyor.com/project/JohnTheGr8/flow-launcher/branch/dev"><img src="https://ci.appveyor.com/api/projects/status/32r7s2skrgm9ubva?svg=true&retina=true"></a>
13+
<a href="https://github.com/Flow-Launcher/Flow.Launcher/releases"><img src="https://img.shields.io/github/downloads/Flow-Launcher/Flow.Launcher/total.svg"></a><br />
14+
<img src="https://img.shields.io/github/release-date/Flow-Launcher/Flow.Launcher">
15+
<a href="https://github.com/Flow-Launcher/Flow.Launcher/releases/latest"><img src="https://img.shields.io/github/v/release/Flow-Launcher/Flow.Launcher"></a>
16+
<a href="https://flow-launcher.github.io/docs"><img src="https://img.shields.io/badge/Documentation-7389D8"></a>
17+
<a href="https://discord.gg/AvgAQgh"><img src="https://img.shields.io/discord/727828229250875472?color=7389D8&labelColor=6A7EC2&label=Community&logo=discord&logoColor=white"></a>
18+
</p>
19+
20+
<p align="center">
21+
Dedicated to making your workflow flow more seamless. Search everything from applications, files, bookmarks, YouTube, Twitter and more. Flow will continue to evolve, designed to be open and built with the community at heart.
22+
23+
<p align="center"> <sub>Remember to star it, flow will love you more :)</sub></p>
24+
25+
<p align="center"><img width="12px" src="https://user-images.githubusercontent.com/26427004/104119722-9033c600-5385-11eb-9d57-4c376862fd36.png"> <a href="https://www.softpedia.com/get/System/Launchers-Shutdown-Tools/Flow-Launcher.shtml">SOFTPEDIA EDITOR'S PICK</a></p>
1426

15-
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.
27+
<img src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png" width="100%">
1628

17-
<sub>Remember to star it, flow will love you more :)</sub>
1829

19-
---
30+
## 🎉 New Features in 1.9
31+
32+
![screenshot](https://user-images.githubusercontent.com/6903107/144855345-45535bc7-7777-4c5a-b8d9-d6ce8adc5e84.png)
33+
34+
- All New Design. New Themes, New Setting Window. Animation & Sound Effect, Color Scheme aka Dark Mode.
35+
- New Plugins, Plugin Store, Game Mode, Wizard window
36+
- <a href="https://github.com/Flow-Launcher/Flow.Launcher/releases/tag/v1.9.0">Full changelog</a>
37+
38+
<img src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png" width="100%">
2039

2140
<h4 align="center">
22-
<a href="#Features">Features</a> •
23-
<a href="#Getting-Started">Getting Started</a> •
41+
<a href="#Getting-Started">Getting Started</a> • <a href="#Features">Features</a> • <a href="#Plugins">Plugins</a> •
42+
<a href="#Hotkeys">Hotkeys</a> •
2443
<a href="#QuestionsSuggestions">Questions/Suggestions</a> •
2544
<a href="#Development">Development</a> •
26-
<a href="https://flow-launcher.github.io/docs">Documentation</a>
45+
<a href="https://flow-launcher.github.io/docs">Docs</a>
2746
</h4>
2847

29-
---
48+
<img src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png" width="100%">
3049

31-
## Features
50+
## 🚗 Getting Started
51+
52+
### Installation
53+
54+
| [Windows 7+ installer](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest/download/Flow-Launcher-Setup.exe) | [Portable](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest/download/Flow-Launcher-Portable.zip) | `WinGet install "Flow Launcher"` |
55+
| :----------------------------------------------------------: | :----------------------------------------------------------: | :------------------------------: |
56+
57+
> 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.
58+
59+
And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/discussions" target="_blank">early access version</a>.
60+
61+
<img src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png" width="100%">
62+
63+
## 🎁 Features
64+
65+
### Applications & Files
66+
67+
<img src="https://user-images.githubusercontent.com/6903107/145332614-74909973-f6eb-47c2-8235-289931e30718.png" width="400">
68+
69+
70+
- Search for files or their contents.
71+
72+
<img src="https://user-images.githubusercontent.com/6903107/145018796-658b7c24-a34f-46b6-98d4-cf4f636d8b60.png" width="400">
3273

33-
![The Flow](https://user-images.githubusercontent.com/26427004/82151677-fa9c7100-989f-11ea-9143-81de60aaf07d.gif)
3474

35-
- Search everything from applications, files, bookmarks, YouTube, Twitter and more. All from the comfort of your keyboard without ever touching the mouse.
36-
- Search for file contents.
37-
- Do mathematical calculations and copy the result to clipboard.
3875
- Support search using environment variable paths.
76+
77+
### Web Search & Open URL
78+
79+
<img src="https://user-images.githubusercontent.com/6903107/144517502-5325de01-d0d9-4c2e-aafb-33c3f5d82f81.png" width="400">
80+
<img src="https://user-images.githubusercontent.com/6903107/144831031-0e01e8ea-3247-4ba4-a7b4-48b0db620bc1.png" width="400">
81+
<img src="https://user-images.githubusercontent.com/6903107/144517519-79ee8a81-083c-42be-b2d7-4990d1cb53e5.png" width="400">
82+
83+
### Browser Bookmarks
84+
85+
<img src="https://user-images.githubusercontent.com/6903107/144517534-5e27547b-77f8-4718-941c-5bc542eed931.png" width="400">
86+
87+
### System Commands
88+
89+
<img src="https://user-images.githubusercontent.com/6903107/144517557-9b5b82fc-6408-48a0-af59-69b385a0782e.png" width="400">
90+
91+
- Provides System related commands. shutdown, lock, settings, etc.
92+
- <a href="#system-command-list">System command list</a>
93+
94+
### Calculator
95+
96+
<img src="https://user-images.githubusercontent.com/6903107/144517570-f0e62716-3fdf-4f2a-8986-385a3fcd0663.png" width="400">
97+
98+
- Do mathematical calculations and copy the result to clipboard.
99+
100+
### Shell Command
101+
102+
<img src="https://user-images.githubusercontent.com/6903107/144517582-83da8414-e03d-402c-863d-22d116d20c31.png" width="400">
103+
39104
- Run batch and PowerShell commands as Administrator or a different user.
40-
- Support languages from Chinese to Italian and more.
41-
- Support wide range of plugins.
42-
- Prioritise the order of each plugin's results.
105+
- Ctrl+Enter to Run as Administrator.
106+
107+
### Explorer
108+
109+
<img src="https://user-images.githubusercontent.com/6903107/144517603-7bfbf868-476a-41d1-bd1b-1ebde7ab2539.png" width="400">
110+
43111
- Save file or folder locations for quick access.
44-
- Fully portable.
45112

46-
[<img width="12px" src="https://user-images.githubusercontent.com/26427004/104119722-9033c600-5385-11eb-9d57-4c376862fd36.png"> **SOFTPEDIA EDITOR'S PICK**](https://www.softpedia.com/get/System/Launchers-Shutdown-Tools/Flow-Launcher.shtml)
113+
### Window Setting & Control Panel
47114

48-
## Getting Started
115+
<img src="https://user-images.githubusercontent.com/6903107/144982305-42a2f63e-0066-4557-9791-0a1c57495ea7.png" width="400">
49116

50-
### Installation
117+
- Search within Window Settings & Control Panel.
51118

52-
| [Windows 7+ installer](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest/download/Flow-Launcher-Setup.exe) | [Portable](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest/download/Flow-Launcher-Portable.zip) | `WinGet install "Flow Launcher"` |
53-
| --------------------------------- | --------------------------------- | --------------------------------- |
54119

55-
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.
120+
### Priority
121+
122+
<img src="https://user-images.githubusercontent.com/6903107/144517677-857a2b0a-4b94-4be0-bc89-f35723ecddf9.png" width="500">
123+
124+
125+
- Prioritise the order of each plugin's results.
126+
127+
### Customization
128+
129+
![Animation5](https://user-images.githubusercontent.com/6903107/144693887-1b92ed16-dca1-4b7e-8644-5e9524cdfb31.gif)
130+
131+
- Window size adjustment, animation, and sound
132+
- Color Scheme (aka Dark Mode)
133+
134+
![themes](https://user-images.githubusercontent.com/6903107/144527796-7c06ca31-d933-4f6b-9eb0-4fb06fa94384.png)
56135

57-
### Usage
58-
- Open flow's search window: <kbd>Alt</kbd>+<kbd>Space</kbd> is the default hotkey.
59-
- Open context menu: on the selected result, press <kbd>Ctrl</kbd>+<kbd>O</kbd>/<kbd>Shift</kbd>+<kbd>Enter</kbd>.
60-
- Cancel/Return to previous screen: <kbd>Esc</kbd>.
61-
- Install/Uninstall/Update plugins: in the search window, type `pm` `install`/`uninstall`/`update` + the plugin name.
136+
- There are various themes and you can make it yourself.
137+
138+
### 💬 Language
139+
140+
- Support languages from Chinese to Italian and more.
141+
- Support Pinyin.
142+
- Translation support this project in [Crowdin](https://crowdin.com/project/flow-launcher)
143+
144+
### Portable
145+
146+
- Fully portable.
62147
- Type `flow user data` to open your saved user settings folder. They are located at:
63148
- If using roaming: `%APPDATA%\FlowLauncher`
64149
- If using portable, by default: `%localappdata%\FlowLauncher\app-<VersionOfYourFlowLauncher>\UserData`
65-
- Type `open log location` to open your logs folder, they are saved along with your user settings folder.
150+
- Type `open log location` to open your logs folder, they are saved along with your user settings folder.
151+
152+
### 🎮 Game Mode
153+
154+
<img src="https://user-images.githubusercontent.com/6903107/144517711-a7396bbb-f7ae-403d-9644-1414edd9e3f1.png" width="150">
155+
156+
- Suspend the hotkey when you are playing games.
157+
158+
<img src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png" width="100%">
159+
160+
## 📦 Plugins
161+
162+
- Support wide range of plugins. Visit [here](https://flow-launcher.github.io/docs/#/plugins) for our plugin portfolio.
163+
- If you are using Python plugins, flow will prompt to either select the location or allow Python (Embeddable) to be automatic downloaded for use.
164+
- Create and publish your own plugin to flow! Take a look at our plugin development documentation for [C#](https://flow-launcher.github.io/docs/#/develop-dotnet-plugins) or [Python](https://flow-launcher.github.io/docs/#/develop-py-plugins)
165+
166+
### Everything
167+
<img src="https://user-images.githubusercontent.com/6903107/144533510-6880ecf4-5f93-4b6a-9c1f-4fcdb99110c3.png" width="400">
168+
169+
### SpotifyPremium
170+
<img src="https://user-images.githubusercontent.com/6903107/144533469-da920295-8c36-46e8-89eb-a9cdd94b74ef.png" width="400">
171+
172+
173+
### Steam Search
174+
<img src="https://user-images.githubusercontent.com/6903107/144533523-afd79dca-a444-40e5-b2d9-6d3fe3aaece1.png" width="400">
175+
176+
177+
### Clipboard History
178+
<img src="https://user-images.githubusercontent.com/6903107/144533481-58e473fd-38d9-4604-861f-ad870770967d.png" width="400">
179+
180+
### Home Assistant Commander
181+
<img src="https://user-images.githubusercontent.com/6903107/144533538-3caa2944-3037-4755-87b9-70fa918d2efa.png" width="400">
182+
183+
### Colors
184+
185+
<img src="https://user-images.githubusercontent.com/6903107/144533487-2caff162-a8f6-4577-af3f-d1b05d423ee4.png" width="400">
186+
187+
### Github
188+
<img src="https://user-images.githubusercontent.com/6903107/144533497-8677f800-95c5-4758-8ca3-c96333ee1943.png" width="400">
189+
190+
### Windows Walker
191+
<img src="https://user-images.githubusercontent.com/6903107/144533517-07bf011f-726c-4221-8657-0e442eca8a82.png" width="400">
192+
193+
......and <a href="https://flow-launcher.github.io/docs/#/plugins">more!</a>
194+
195+
<img src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png" width="100%">
196+
197+
### 🛒 Plugin Store
198+
199+
![pluginstore](https://user-images.githubusercontent.com/6903107/144528115-3b6baa89-f53f-40db-8426-02c4db8dd2b5.png)
200+
201+
- You can view the full plugin list or quickly install a plugin via the Plugin Store menu in Settings
202+
203+
- or type `pm` `install`/`uninstall`/`update` + the plugin name in the search window,
204+
205+
206+
<img src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png" width="100%">
207+
208+
## ⌨️ Hotkeys
66209

67-
[More tips](https://flow-launcher.github.io/docs/#/usage-tips)
210+
| Hotkey | Description |
211+
| ------------------------------------------------------------ | -------------------------------------------- |
212+
| <kbd>Alt</kbd>+ <kbd>Space</kbd> | Open Search Box (Default and Configurable) |
213+
| <kbd>Enter</kbd> | Execute |
214+
| <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Enter</kbd> | Run As Admin |
215+
| <kbd>↑</kbd><kbd>↓</kbd> | Scroll up & Down |
216+
| <kbd>←</kbd><kbd>→</kbd> | Back to Result / Open Context Menu |
217+
| <kbd>Ctrl</kbd> +<kbd>o</kbd> , <kbd>Shift</kbd> +<kbd>Enter</kbd> | Open Context Menu |
218+
| <kbd>Tab</kbd> | Autocomplete |
219+
| <kbd>Esc</kbd> | Back to Result & Close |
220+
| <kbd>Ctrl</kbd> +<kbd>i</kbd> | Open Setting Window |
221+
| <kbd>F5</kbd> | Reload All Plugin Data & Window Search Index |
222+
| <kbd>Ctrl</kbd> + <kbd>h</kbd> | Open Query History |
68223

69-
### Plugins
70224

71-
Flow searches files and contents via Windows Index Search, to use **Everything**: `pm install everything`.
225+
## System Command List
72226

73-
If you are using Python plugins, flow will prompt to either select the location or allow Python (Embeddable) to be automatic downloaded for use.
227+
| Command | Description |
228+
| ---------------------- | ------------------------------------------------------------ |
229+
| Shutdown | Shutdown computer |
230+
| Restart | Restart computer |
231+
| Restart with advance | Restart the computer with Advanced Boot option for safe and debugging modes |
232+
| Log off | Log off |
233+
| Lock | Lock computer |
234+
| Sleep | Put computer to sleep |
235+
| Hibernate | Hibernate computer |
236+
| Empty Recycle Bin | Empty recycle bin |
237+
| Exit | Close Flow Launcher |
238+
| Save Settings | Save all Flow Launcher settings |
239+
| Restart Flow Launcher | Restart Flow Launcher |
240+
| Settings | Tweak this app |
241+
| Reload Plugin Data | Refreshes plugin data with new content |
242+
| Check For Update | Check for new Flow Launcher update |
243+
| Open Log Location | Open Flow Launcher's log location |
244+
| Flow Launcher Tip | Visit Flow Launcher's documentation for more help and how to use tips |
245+
| Flow Launcher UserData | Open the location where Flow Launcher's settings are stored |
74246

75-
Vist [here](https://flow-launcher.github.io/docs/#/plugins) for our plugin portfolio.
247+
### 💁‍♂️ Tips
76248

77-
If you are keen to write your own plugin for flow, please take a look at our plugin development documentation for [C#](https://flow-launcher.github.io/docs/#/develop-dotnet-plugins) or [Python](https://flow-launcher.github.io/docs/#/develop-py-plugins)
249+
- [More tips](https://flow-launcher.github.io/docs/#/usage-tips)
78250

79-
## Questions/Suggestions
251+
<img src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png" width="100%">
80252

81-
Yes please, let us know in the [Q&A](https://github.com/Flow-Launcher/Flow.Launcher/discussions/categories/q-a) section.
253+
## ❔ Questions/Suggestions
82254

83-
**Join our community on [Discord](https://discord.gg/AvgAQgh)!**
255+
Yes please, let us know in the [Q&A](https://github.com/Flow-Launcher/Flow.Launcher/discussions/categories/q-a) section. **Join our community on [Discord](https://discord.gg/AvgAQgh)!**
84256

85257
## Development
86258

@@ -98,8 +270,8 @@ Get in touch if you like to join the Flow-Launcher Team and help build this grea
98270

99271
### Developing/Debugging
100272

101-
Flow Launcher's target framework is .Net 5
273+
- Flow Launcher's target framework is .Net 5
102274

103-
Install Visual Studio 2019
275+
- Install Visual Studio 2019
104276

105-
Install .Net 5 SDK via Visual Studio installer or manually from [here](https://dotnet.microsoft.com/download/dotnet/thank-you/sdk-5.0.103-windows-x64-installer)
277+
- Install .Net 5 SDK via Visual Studio installer or manually from [here](https://dotnet.microsoft.com/download/dotnet/thank-you/sdk-5.0.103-windows-x64-installer)

0 commit comments

Comments
 (0)