From 1ff572da03a3f8b69c2daffc78a9daca7774b284 Mon Sep 17 00:00:00 2001 From: Christopher Schnick Date: Tue, 28 Mar 2023 13:56:11 +0200 Subject: [PATCH] Update README.md --- README.md | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 463ce366..b3a20994 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,33 @@ to implement custom functionality through custom extensions. ## Getting Started Head over to the [releases page](https://github.com/xpipe-io/xpipe/releases) and try it out. + Feel free to file tickets for bugs or feature requests. Upvote 👍 the ones you'd like to see prioritized. + There are several ways to reach out in case you encounter any issues or questions: - The [X-Pipe Discord Server](https://discord.gg/8y89vS8cRb) - The [X-Pipe Slack Server](https://join.slack.com/t/x-pipe/shared_invite/zt-1awjq0t5j-5i4UjNJfNe1VN4b_auu6Cg) ## Features +### Remote file explorer + +- Access files on any remote system +- Quickly open a terminal into any directory +- Run commands from the explorer interface +- Utilize your favourite local programs to open and edit remote files + +drawing + +### Manage all your connections in one place + +- Easily create and manage all kinds of remote connections at one location +- Securely stores all information exclusively on your computer and encrypts all secret information +- Share connection configurations to any other trusted party through shareable URLs +- Create desktop shortcuts for your connections + +drawing + ### Flexible remote connector - Can connect to standard servers, database servers, and more @@ -35,24 +55,6 @@ There are several ways to reach out in case you encounter any issues or question - Allows you to customize the launched shell's init environment - Supports launches from the GUI or command-line -### Manage all your connections in one place - -- Easily create and manage all kinds of remote connections at one location -- Securely stores all information exclusively on your computer and encrypts all secret information -- Share connection configurations to any other trusted party through shareable URLs -- Create desktop shortcuts for your connections - -drawing - -### Remote file explorer - -- Access files on any remote system -- Quickly open a terminal into any directory -- Run commands from the explorer interface -- Utilize your favourite local programs to open and edit remote files - -drawing - ## Repository Structure The following for modules make up the X-Pipe API and a licensed under the MIT license: @@ -70,13 +72,11 @@ The other modules make up the X-Pipe implementation and are licensed under GPL: X-Pipe utilizes an open core model, which essentially means that the main application is open source while certain other components are not. +Select parts are not open source yet, but may be added to this repository in the future. Some tests and especially test environments and that run on private servers are also not included in this repository (Don't want to leak server information). -Finally, scripts and workflows to create signed executables and installers -are also not included to prevent attackers from easily impersonating the shipping the X-Pipe application malware. - -The license model is chosen in such a way that you are -able to use and integrate X-Pipe within your application through the MIT-licensed API. +Finally, scripts and workflows to create (signed) executables and installers +are also not included to prevent attackers from easily impersonating the X-Pipe application. ## Development