Skip to content

Commit dd8135e

Browse files
authored
update readme
1 parent d993cf4 commit dd8135e

File tree

2 files changed

+31
-33
lines changed

2 files changed

+31
-33
lines changed

Plugins/Flow.Launcher.Plugin.WebSearch/SearchSourceViewModel.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,4 @@ internal ImageSource LoadPreviewIcon(string pathToPreviewIconImage)
6262
return ImageLoader.Load(pathToPreviewIconImage);
6363
}
6464
}
65-
}
65+
}

README.md

Lines changed: 30 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Dedicated to making your workflow flow more seamless. Search everything from app
2727
<img src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png" width="100%">
2828

2929

30-
## 🎉 New Features in 1.9
30+
## 🎉 New Features in 1.9
3131

3232
![screenshot](https://user-images.githubusercontent.com/6903107/144855345-45535bc7-7777-4c5a-b8d9-d6ce8adc5e84.png)
3333

@@ -54,7 +54,7 @@ Dedicated to making your workflow flow more seamless. Search everything from app
5454
| [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"` | `scoop install Flow-Launcher` |
5555
| :----------------------------------------------------------: | :----------------------------------------------------------: | :------------------------------: | :------------------------------: |
5656

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.
57+
> When installing for the first time Windows may raise an issue about security due to code not being signed, if you downloaded from this repo then you are good to continue the set up.
5858
5959
And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/discussions" target="_blank">early access version</a>.
6060

@@ -67,14 +67,14 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis
6767
<img src="https://user-images.githubusercontent.com/6903107/145332614-74909973-f6eb-47c2-8235-289931e30718.png" width="400">
6868

6969

70-
- Search for files or their contents.
70+
- Search for apps, files or file contents.
7171

7272
<img src="https://user-images.githubusercontent.com/6903107/145018796-658b7c24-a34f-46b6-98d4-cf4f636d8b60.png" width="400">
7373

7474

7575
- Support search using environment variable paths.
7676

77-
### Web Search & Open URL
77+
### Web Searches & URLs
7878

7979
<img src="https://user-images.githubusercontent.com/6903107/144517502-5325de01-d0d9-4c2e-aafb-33c3f5d82f81.png" width="400">
8080
<img src="https://user-images.githubusercontent.com/6903107/144831031-0e01e8ea-3247-4ba4-a7b4-48b0db620bc1.png" width="400">
@@ -88,14 +88,14 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis
8888

8989
<img src="https://user-images.githubusercontent.com/6903107/144517557-9b5b82fc-6408-48a0-af59-69b385a0782e.png" width="400">
9090

91-
- Provides System related commands. shutdown, lock, settings, etc.
91+
- Provides system related commands. shutdown, lock, settings, etc.
9292
- <a href="#system-command-list">System command list</a>
9393

9494
### Calculator
9595

9696
<img src="https://user-images.githubusercontent.com/6903107/144517570-f0e62716-3fdf-4f2a-8986-385a3fcd0663.png" width="400">
9797

98-
- Do mathematical calculations and copy the result to clipboard.
98+
- Do mathematical calculations and copy the result to clipboard.
9999

100100
### Shell Command
101101

@@ -110,11 +110,11 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis
110110

111111
- Save file or folder locations for quick access.
112112

113-
### Window Setting & Control Panel
113+
### Windows & Control Panel Settings
114114

115115
<img src="https://user-images.githubusercontent.com/6903107/144982305-42a2f63e-0066-4557-9791-0a1c57495ea7.png" width="400">
116116

117-
- Search within Window Settings & Control Panel.
117+
- Search for Windows & Control Panel settings.
118118

119119

120120
### Priority
@@ -124,7 +124,7 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis
124124

125125
- Prioritise the order of each plugin's results.
126126

127-
### Customization
127+
### Customizations
128128

129129
![Animation5](https://user-images.githubusercontent.com/6903107/144693887-1b92ed16-dca1-4b7e-8644-5e9524cdfb31.gif)
130130

@@ -133,27 +133,27 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis
133133

134134
![themes](https://user-images.githubusercontent.com/6903107/144527796-7c06ca31-d933-4f6b-9eb0-4fb06fa94384.png)
135135

136-
- There are various themes and you can make it yourself.
136+
- There are various themes and you also can make your own.
137137

138138
### 💬 Language
139139

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)
140+
- Supports languages from Chinese to Italian and more.
141+
- Supports Pinyin search.
142+
- [Crowdin](https://crowdin.com/project/flow-launcher) support for language translations.
143143

144144
### Portable
145145

146146
- Fully portable.
147147
- Type `flow user data` to open your saved user settings folder. They are located at:
148148
- If using roaming: `%APPDATA%\FlowLauncher`
149-
- If using portable, by default: `%localappdata%\FlowLauncher\app-<VersionOfYourFlowLauncher>\UserData`
149+
- If using portable, by default: `%localappdata%\FlowLauncher\app-<VersionOfYourFlowLauncher>\UserData`
150150
- Type `open log location` to open your logs folder, they are saved along with your user settings folder.
151151

152152
### 🎮 Game Mode
153153

154154
<img src="https://user-images.githubusercontent.com/6903107/144517711-a7396bbb-f7ae-403d-9644-1414edd9e3f1.png" width="150">
155155

156-
- Suspend the hotkey when you are playing games.
156+
- Pause hotkey activation when you are playing games.
157157

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

@@ -164,6 +164,7 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis
164164

165165
<p align="center">
166166
<a href="https://flowlauncher.com/docs/#/develop-dotnet-plugins"><img src="https://user-images.githubusercontent.com/6903107/147870065-4096f233-147c-434e-a3ac-69519582605f.png" width="64"></a>
167+
<a href="https://github.com/Flow-Launcher/plugin-samples/tree/master/HelloWorldFSharp"><img src="https://user-images.githubusercontent.com/26427004/156536959-dfdc7be8-4b59-4587-9c6a-a297903e4ce1.png" width="64"></a>
167168
<a href="https://www.flowlauncher.com/docs/#/py-develop-plugins"><img src="https://user-images.githubusercontent.com/6903107/147870066-7599eb15-0333-468e-82e8-4d432ceb5a45.png" width="64"></a>
168169
<a href="https://flowlauncher.com/docs/#/nodejs-develop-plugins"><img src="https://user-images.githubusercontent.com/6903107/147870071-d67c736b-0748-428f-a283-14587696dfa3.png" width="64"></a>
169170
<a href="https://flowlauncher.com/docs/#/nodejs-develop-plugins"><img src="https://user-images.githubusercontent.com/6903107/147870069-9bde6fe6-d50c-4d85-8fde-fe5ae921ab8c.png" width="64"></a>
@@ -192,7 +193,7 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis
192193

193194
### Github
194195
<img src="https://user-images.githubusercontent.com/6903107/144533497-8677f800-95c5-4758-8ca3-c96333ee1943.png" width="400">
195-
196+
196197
### Window Walker
197198
<img src="https://user-images.githubusercontent.com/6903107/144533517-07bf011f-726c-4221-8657-0e442eca8a82.png" width="400">
198199

@@ -204,7 +205,7 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis
204205

205206
![pluginstore](https://user-images.githubusercontent.com/6903107/144528115-3b6baa89-f53f-40db-8426-02c4db8dd2b5.png)
206207

207-
- You can view the full plugin list or quickly install a plugin via the Plugin Store menu in Settings
208+
- You can view the full plugin list or quickly install a plugin via the Plugin Store menu inside Settings
208209

209210
- or type `pm` `install`/`uninstall`/`update` + the plugin name in the search window,
210211

@@ -215,18 +216,19 @@ And you can download <a href="https://github.com/Flow-Launcher/Flow.Launcher/dis
215216

216217
| Hotkey | Description |
217218
| ------------------------------------------------------------ | -------------------------------------------- |
218-
| <kbd>Alt</kbd>+ <kbd>Space</kbd> | Open Search Box (default and configurable) |
219+
| <kbd>Alt</kbd>+ <kbd>Space</kbd> | Open search window (default and configurable)|
219220
| <kbd>Enter</kbd> | Execute |
220-
| <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Enter</kbd> | Run As Admin |
221-
| <kbd>↑</kbd><kbd>↓</kbd> | Scroll up & Down |
222-
| <kbd>←</kbd><kbd>→</kbd> | Back to Result / Open Context Menu |
223-
| <kbd>Ctrl</kbd> +<kbd>o</kbd> , <kbd>Shift</kbd> +<kbd>Enter</kbd> | Open Context Menu |
221+
| <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Enter</kbd> | Run commands from Shell plugin as admin |
222+
| <kbd>↑</kbd><kbd>↓</kbd> | Scroll up & down |
223+
| <kbd>←</kbd><kbd>→</kbd> | Back to result / Open Context Menu |
224+
| <kbd>Ctrl</kbd> +<kbd>O</kbd> , <kbd>Shift</kbd> +<kbd>Enter</kbd> | Open Context Menu |
224225
| <kbd>Tab</kbd> | Autocomplete |
225-
| <kbd>Esc</kbd> | Back to Result & Close |
226-
| <kbd>Ctrl</kbd> +<kbd>i</kbd> | Open Setting Window |
227-
| <kbd>F5</kbd> | Reload All Plugin Data & Window Search Index |
228-
| <kbd>Ctrl</kbd> + <kbd>h</kbd> | Open Query History |
229-
| <kbd>Ctrl</kbd> + <kbd>Backspace</kbd> | Back to Previous Directory |
226+
| <kbd>Esc</kbd> | Back to results / hide search window |
227+
| <kbd>Ctrl</kbd> +<kbd>C</kbd> | Copy the actual folder / file |
228+
| <kbd>Ctrl</kbd> +<kbd>I</kbd> | Open Settings window |
229+
| <kbd>F5</kbd> | Reload all plugin data |
230+
| <kbd>Ctrl</kbd> + <kbd>H</kbd> | Open search history |
231+
| <kbd>Ctrl</kbd> + <kbd>Backspace</kbd> | Back to previous directory |
230232

231233

232234
## System Command List
@@ -263,13 +265,9 @@ Yes please, let us know in the [Q&A](https://github.com/Flow-Launcher/Flow.Launc
263265

264266
## Development
265267

266-
### Status
267-
268-
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.
269-
270268
### Contributing
271269

272-
We welcome all contributions. If you are unsure of a change you want to make, let us know in the [Discussions](https://github.com/Flow-Launcher/Flow.Launcher/discussions/categories/ideas), otherwise feel free to put in a pull request.
270+
Contributions are very welcome, in addition to the main project(C#) there are also [documentation](https://github.com/Flow-Launcher/docs)(md), [website](https://github.com/Flow-Launcher/flow-launcher.github.io)(html/css) and [others](https://github.com/Flow-Launcher) that can be contributed to. If you are unsure of a change you want to make, let us know in the [Discussions](https://github.com/Flow-Launcher/Flow.Launcher/discussions/categories/ideas), otherwise feel free to put in a pull request.
273271

274272
You will find the main goals of flow placed under the [Projects board](https://github.com/Flow-Launcher/Flow.Launcher/projects), so feel free to contribute on that. If you would like to make small incremental changes, feel free to do so as well.
275273

0 commit comments

Comments
 (0)