Skip to content

Commit cb84d49

Browse files
committed
updated readme
1 parent 00caad6 commit cb84d49

File tree

3 files changed

+55
-23
lines changed

3 files changed

+55
-23
lines changed

.README/header.png

32.5 KB
Loading

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2020 free-bots
3+
Copyright (c) 2021 free-bots
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 54 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,52 @@
1-
```
2-
_ _
3-
| | | |
4-
_ __ _ __ ___ | |_| |_ _ ______ ___ ___ _ ____ _____ _ __
5-
| '__| '_ ` _ \| __| | | | |______/ __|/ _ \ '__\ \ / / _ \ '__|
6-
| | | | | | | | |_| | |_| | \__ \ __/ | \ V / __/ |
7-
|_| |_| |_| |_|\__|_|\__, | |___/\___|_| \_/ \___|_|
8-
__/ |
9-
|___/
10-
```
1+
# Rmtly-Server
2+
![](./.README/header.png)
113

12-
## About
13-
rmtly-server is a server application written in golang that allows you to start application with a rest api
4+
<p align="center">Server for remote control your pc 💻</p>
5+
6+
<p align="center">
7+
<a href="https://github.com/free-bots/rmtly-server/releases" alt="GitHub release (latest by date)">
8+
<img alt="GitHub" src="https://img.shields.io/github/v/release/free-bots/rmtly-server?style=flat-square"></a>
9+
<a href="https://github.com/free-bots/rmtly-server/blob/master/LICENSE.md" alt="License">
10+
<img alt="GitHub" src="https://img.shields.io/github/license/free-bots/rmtly-server?style=flat-square"></a>
11+
<a href="https://github.com/free-bots/rmtly-server/graphs/contributors" alt="Contributors">
12+
<img alt="GitHub" src="https://img.shields.io/github/contributors/free-bots/rmtly-server?style=flat-square"></a>
13+
</p>
14+
15+
# Table of Contents
16+
17+
- [Rmtly-Server](#rmtly-server)
18+
- [Table of Contents](#table-of-contents)
19+
- [Features](#features)
20+
- [Requirements](#requirements)
21+
- [Ubuntu](#ubuntu)
22+
- [Arch Linux](#arch-linux)
23+
- [Build](#build)
24+
- [Run](#run)
25+
- [Contribution](#contribution)
26+
- [About](#about)
27+
- [API](#api)
28+
- [Get all applications](#get-all-applications)
29+
- [Get single application](#get-single-application)
30+
- [Run an application](#run-an-application)
31+
- [Get icon of an application](#get-icon-of-an-application)
32+
- [SignUp a device](#signup-a-device)
33+
- [Configuration](#configuration)
34+
- [Default Config](#default-config)
35+
- [Mobile App](#mobile-app)
36+
- [License](#license)
37+
38+
## Features
1439

40+
- List all installed applications of your pc
41+
- List all application categories of your pc
42+
- Start applications with or without delay
1543

1644
## Requirements
17-
Ubuntu
45+
### Ubuntu
1846
```
1947
sudo apt install libgtk-3-dev libcairo2-dev libglib2.0-dev libnotify-bin
2048
```
21-
Arch Linux
49+
### Arch Linux
2250
```
2351
sudo pacman -S gtk3 libnotify
2452
```
@@ -29,6 +57,13 @@ Run `make` or `make build` and at `<project directory>/bin` the binary called rm
2957
## Run
3058
After building the project run `make run` or open the rmtly-server file in the build directory.
3159

60+
## Contribution
61+
62+
If you miss an important feature fell free to contribute or create a feature request.
63+
64+
## About
65+
rmtly-server is a server application written in golang that allows you to start application with a rest api
66+
3267
## API
3368
### Get all applications
3469
```
@@ -58,7 +93,7 @@ after requesting the code go to the terminal and scan the created qr code or typ
5893
}
5994
```
6095
to `http://localhost:3000/authentication/signUp`
61-
after that you get an jwt and add it to your headers for the requests
96+
after that you get a jwt and add it to your headers for the requests
6297

6398
### Configuration
6499
The config file for this server is located at `.config/rmtly-server/config.json` this file is auto generated if not available.
@@ -67,25 +102,22 @@ The config file for this server is located at `.config/rmtly-server/config.json`
67102
```
68103
{
69104
"application": { "cacheExpiresInMillis": 10000 },
70-
"image": {
71-
"cacheExpiresInMillis": 10000,
72-
"maxImagesInCache": 100, //number of images in the cache
73-
"imageQuality": 512 // size in pixels
74-
},
75105
"security": {
76106
"expirationInDays": 99, // jwt expiration time
77107
"secret": "authenticationCode",
78-
"keyFile": ""
79108
},
80109
"network": { "address": "0.0.0.0:3000" }
81110
}
82111
```
83112

113+
## Mobile App
114+
Check out [Rmtly](https://github.com/free-bots/rmtly) to control your pc with your phone.
115+
84116

85117
## License
86118
> MIT License
87119
88-
> Copyright (c) 2020 free-bots
120+
> Copyright (c) 2021 free-bots
89121
90122
> Permission is hereby granted, free of charge, to any person obtaining a copy
91123
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)