diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a1ec68b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,5 @@ +# Contributing to this project + +This file is being written. + +For informations on how to build this project, see issue #43 diff --git a/README.md b/README.md index 059f288..9e7e746 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,29 @@ + + +
# SSHFS-Win Manager ## Introduction -SSHFS-Win Manager is a GUI (graphics user interface) for [SSHFS-Win](https://github.com/billziss-gh/sshfs-win). +SSHFS-Win Manager is a GUI (graphics user interface) for SSHFS on Windows (comming soon for other platforms). ## Installation -First you must have SSHFS-Win installed on your Windows computer. +**Step 1** + +Install SSHFS-Win on your Windows computer. Follow they [installation instructions](https://github.com/billziss-gh/sshfs-win/blob/master/README.md) before continue. +**Step 2** + 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. -You're ready to go! +**Step 3** + +Add your connections and enjoy! ## Features @@ -24,28 +33,44 @@ You're ready to go! - User-friendly and intuitive interface - Multiple authentication methods: - - Password - - Private Key (without password) + - Password1 + - Private Key (without password) + - Ask for password - Startup with Windows - Close to system tray +- Quick debug tool +- Supports advanced command line params +- Easily duplicate connections +- Reorder connections +- Connection debug log ## Screenshots -![Main Window](https://c.servers.babum.dev/static/sshfs-win-manager/main-window-screenshot.png) +![Main Window](https://lw1.net.babum.dev/static/sshfs-win-manager/main-window-screenshot.png) *Main Window* -![Add Connection](https://c.servers.babum.dev/static/sshfs-win-manager/add-connection-screenshot.png) +![Add Connection](https://lw1.net.babum.dev/static/sshfs-win-manager/add-connection-screenshot.png) *Add & edit connections* -![Open mounted drive](https://c.servers.babum.dev/static/sshfs-win-manager/explorer-screenshot.png) +![Open mounted drive](https://lw1.net.babum.dev/static/sshfs-win-manager/explorer-screenshot.png) *Explore mounted drive* -![System tray](https://c.servers.babum.dev/static/sshfs-win-manager/systray-screenshot.png) +![System tray](https://lw1.net.babum.dev/static/sshfs-win-manager/systray-screenshot.png) *Close to system tray* ## Bugs & help If you have any question or a bug report please open a [new issue](https://github.com/evsar3/sshfs-win-manager/issues/new) +## Contributing +If you want to contribute with this project, please see the [contributing guide-lines](https://github.com/evsar3/sshfs-win-manager/blob/master/CONTRIBUTING.md) +If you just want to build or compile this project see instructions [here](https://github.com/evsar3/sshfs-win-manager/blob/master/CONTRIBUTING.md#building-and-compiling) + +## Donation +If you like this project, please consider [making a donation](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=HXZUJ8WX47238). 100% of the founds will be revert for charity. + +## Notes +1 This software stores your password in a plain json file. If there is any concerns on storing your password that way, please use one of the other authentication methods. See issue #28 + ## License MIT License diff --git a/donation-concluded.md b/donation-concluded.md new file mode 100644 index 0000000..74d26af --- /dev/null +++ b/donation-concluded.md @@ -0,0 +1,7 @@ +Thank you for your donation!
+ +Your donation will be redirected to the Associação de Ajuda Mútua do Pirambú - ACAMP (Pirambú Mutual Aid Community Association), in Fortaleza, Brazil. + +ACAMP helps homeless children by providing them with shelter and food. Currently with the pandemic, the number of volunteers and donations has decreased and more than ever they need help. + +On behalf of all the voluntiers, my family and the children helped by this project, I want to thank you for your donation. diff --git a/package.json b/package.json index f44ea2e..e5db6e6 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "sshfs-win-manager", - "version": "1.1.0-beta.2", + "version": "1.2.0", "author": "Evandro Araujo