Skip to content

Commit 573d7fa

Browse files
committed
Nicer readme
1 parent 74f7c6a commit 573d7fa

File tree

1 file changed

+63
-3
lines changed

1 file changed

+63
-3
lines changed

README.md

Lines changed: 63 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,70 @@
1+
<div style="text-align: center; margin-top: 3em;">
2+
<img src="https://img.shields.io/github/v/release/evsar3/sshfs-win-manager?sort=semver">
3+
<img src="https://img.shields.io/github/downloads/evsar3/sshfs-win-manager/total">
4+
<img src="https://img.shields.io/github/issues-raw/evsar3/sshfs-win-manager/bug?color=red">
5+
</div>
6+
17
# SSHFS-Win Manager
28

9+
## Introduction
10+
SSHFS-Win Manager is a GUI (graphics user interface) for [SSHFS-Win](https://github.com/billziss-gh/sshfs-win).
11+
312
## Installation
413
First you must have SSHFS-Win installed on your Windows computer.
514
Follow they [installation instructions](https://github.com/billziss-gh/sshfs-win/blob/master/README.md) before continue.
615

7-
Once SSHFS-Win is installed, download the setup from the 'releases' section and install it.
8-
By now, only password-based authentication is available.
16+
Once SSHFS-Win is installed, [**download the lastest setup**](https://github.com/evsar3/sshfs-win-manager/releases/latest) from the [releases](https://github.com/evsar3/sshfs-win-manager/releases) section and install it.
17+
18+
You're ready to go!
19+
20+
## Features
21+
22+
- Lightweight electron-based application. [Electron](https://github.com/electron/electron) is the same engine that powers [Visual Studio Code](https://github.com/microsoft/vscode), [Discord](https://discordapp.com/), [GitKraken](https://www.gitkraken.com/) and [many more](https://www.electronjs.org/apps).
23+
24+
- User-friendly and intuitive interface
25+
26+
- Multiple authentication methods:
27+
- Password
28+
- Private Key (without password)
29+
30+
- Startup with Windows
31+
- Close to system tray
32+
33+
## Screenshots
34+
![Main Window](https://c.servers.babum.dev/static/sshfs-win-manager/main-window-screenshot.png)
35+
*Main Window*
36+
37+
![Add Connection](https://c.servers.babum.dev/static/sshfs-win-manager/add-connection-screenshot.png)
38+
*Add & edit connections*
39+
40+
![Open mounted drive](https://c.servers.babum.dev/static/sshfs-win-manager/explorer-screenshot.png)
41+
*Explore mounted drive*
42+
43+
![Main Window](https://c.servers.babum.dev/static/sshfs-win-manager/systray-screenshot.png)
44+
*Close to system tray*
45+
46+
## Bugs & help
47+
If you have any question or a bug report please open a [new issue](https://github.com/evsar3/sshfs-win-manager/issues/new)
48+
49+
## License
50+
MIT License
51+
52+
Copyright (c) 2020 Evandro Araújo
53+
54+
Permission is hereby granted, free of charge, to any person obtaining a copy
55+
of this software and associated documentation files (the "Software"), to deal
56+
in the Software without restriction, including without limitation the rights
57+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
58+
copies of the Software, and to permit persons to whom the Software is
59+
furnished to do so, subject to the following conditions:
60+
61+
The above copyright notice and this permission notice shall be included in all
62+
copies or substantial portions of the Software.
963

10-
"A nicer README is comming soon when I have some spare time to make it. If you like this project feel free to make a pull request"
64+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
65+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
66+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
67+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
68+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
69+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
70+
SOFTWARE.

0 commit comments

Comments
 (0)