hugh/soyuz-cli
1
Fork 0
Code Issues Pull requests Actions Packages Projects Releases 3 Wiki Activity

add to readme

Browse source
This commit is contained in:
Hugh Rundle 2023-04-02 08:55:41 +10:00
parent 71b92d5900
commit c2bb66b514
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -32,4 +32,8 @@ Once installed, run `soyuz settings` to create a new settings file. The settings
* `local_dir` - the directory on your local machine where your Gemini files are saved * `local_dir` - the directory on your local machine where your Gemini files are saved
* `remote_dir` - the SSH remote directory path to your files on the server. This includes the server name or ip address, so should look something like `gemini-server:/srv/gemini/example.com` or `username@123.456.789:/srv/gemini/example.com`. * `remote_dir` - the SSH remote directory path to your files on the server. This includes the server name or ip address, so should look something like `gemini-server:/srv/gemini/example.com` or `username@123.456.789:/srv/gemini/example.com`.
* `editor` - the command to open the text editor you want to use. Defaults to `nano`. * `editor` - the command to open the text editor you want to use. Defaults to `nano`.
* `index_heading` - the heading text above the latest posts listing on your homepage. If unsure, leave this on the default. * `index_heading` - the heading text above the latest posts listing on your homepage. If unsure, leave this on the default.
## Commands
Run `soyuz help` for a list of commands and what they do.