robin/clipboard-sync
1
0
Fork 0
mirror of https://github.com/icewind1991/clipboard-sync synced 2026-06-03 10:24:06 +02:00
Code Issues Releases Wiki Activity

update readme

Browse source
This commit is contained in:
Robin Appelman 2018-07-31 01:11:38 +02:00
commit e4c6d2d048
1 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -1,5 +1,8 @@
# clipboard-sync # clipboard-sync
[![Build Status](https://travis-ci.org/icewind1991/clipboard-sync.svg?branch=master)](https://travis-ci.org/icewind1991/clipboard-sync)
[![Build status](https://ci.appveyor.com/api/projects/status/svqv23e4milvtgih?svg=true)](https://ci.appveyor.com/project/icewind1991/clipboard-sync)
Synchronize clipboard between computers Synchronize clipboard between computers
## Usage ## Usage
@ -13,6 +16,7 @@ Simply run the server executable to start the server, by default the server list
this can be changed by setting the `PORT` environment variable. this can be changed by setting the `PORT` environment variable.
A pre-built docker image with the server is available as `clipboardsync/server` A pre-built docker image with the server is available as `clipboardsync/server`
and a static binary is available in the [releases](https://github.com/icewind1991/clipboard-sync/releases) page.
The server is currently only tested on linux, but should run on all platforms with The server is currently only tested on linux, but should run on all platforms with
proper rust support. proper rust support.
@ -27,6 +31,7 @@ client ws://example.com my_session_key
``` ```
The client is currently tested on linux(X11) and windows, but should also work fine on OSX and BSD. The client is currently tested on linux(X11) and windows, but should also work fine on OSX and BSD.
Prebuild binaries for windows can be found on the [releases](https://github.com/icewind1991/clipboard-sync/releases) page.
## Building ## Building