James Read 5 лет назад
Родитель
Сommit
983b35f013
1 измененных файлов с 19 добавлено и 6 удалено
  1. 19 6
      README.md

+ 19 - 6
README.md

@@ -2,12 +2,25 @@
 
 OliveTin is a web interface for running Linux shell commands.
 
-For example, it can be used to turn home automation lights on or off, or start
-workflows in n8n.  
+Some example **use cases**;
 
-## Video demo
+1. Give controlled access to run shell commands to less technical folks who cannot be trushed with SSH. I use this so my family can `podman restart plex` without asking me, and without giving them shell access!
+2. Great for home automation tablets stuck on walls around your house - I use this to turn Hue lights on and off for example. 
+3. Sometimes SSH access isn't possible to a server, or you are feeling too lazy to type a long command you run regulary! I use this to send Wake on Lan commands to servers around my house.
 
-TODO
+## YouTube video demo (6 mins)
+
+[![6 minute demo video](https://img.youtube.com/vi/Ej6NM9rmZtk/0.jpg)](https://www.youtube.com/watch?v=Ej6NM9rmZtk)
+
+## Features
+
+* **Responsive, touch-friendly UI** - great for tablets and mobile
+* **Dark mode** - for those of you that roll that way.
+* **Accessible** - passes all the accessibility checks in Firefox, and issues with accessibility are taken seriously.  
+* **Container** - available for quickly testing and getting it up and running, great for the selfhosted community. 
+* **Integrate with anything** - OliveTin just runs Linux shell commands, so theoretially you could integrate with a bunch of stuff just by using curl, ping, etc. However, writing your own shell scripts is a great way to extend OliveTin.
+* **Lightweight on resources** - uses only a few MB of RAM and barely any CPU. Written in Go, with a web interface written as a modern, responsive, Single Page App that uses the REST/gRPC API.
+* **Good amount of unit tests and style checks** - helps potential contributors be consistent, and helps with maintainability.
 
 ## Screenshots
 
@@ -23,7 +36,7 @@ Mobile screen size (responsive layout);
 
 ![Mobile screenshot](media/screenshotMobile.png)
 
-## `config.yaml` example
+## Example `config.yaml` 
 
 Put this `config.yaml` in `/etc/OliveTin/` if you're running a standard service, or mount it at `/config` if running in a container.
 
@@ -53,7 +66,7 @@ By default OliveTin will use the following ports;
 * `1338` - for the REST API (the api the web interface uses to do stuff)
 * `1339` - a modern gRPC API (OliveTin uses protobuf under the hood) 
 
-Some people might not want the gRPC API public - simply set `listenAddressGrpcActions: 127.0.0.1:1339` in your config so it doesn't listen publicly. It cannot be disabled completely - it's required for the REST API to work though.
+Some people might not want the gRPC API public - simply set `listenAddressGrpcActions: 127.0.0.1:1339` in your config so it doesn't listen publicly. It cannot be disabled completely - it's required for the REST API to work.
 
 ## Installation - systemd service (recommended)