Skip to content

Commit

Permalink
add docs for URLs
Browse files Browse the repository at this point in the history
  • Loading branch information
oktalz committed Dec 3, 2024
1 parent 9e9ea66 commit 417cf75
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,15 @@ NAME
FLAGS
-v, --version show version
-h, --host STRING address that present will listen on (default: 127.0.0.1)
-p, --port INT port that present will listen on (default: 8080)
-t, --tag show tag
-c, --compress STRING compress current folder
-f, --file STRING file to open (.tar.gz format)
-g, --git STRING git repository URL
--key STRING ssh key used for git clone auth
-d, --dir STRING directory to open
--help help
-h, --host STRING address that present will listen on (default: 127.0.0.1)
-p, --port INT port that present will listen on (default: 8080)
--admin-pwd STRING admin password
--user-pwd STRING user password
--admin-pwd-disable disable admin password
Expand All @@ -76,6 +76,13 @@ FLAGS
- user can start presentation with `present -f present.tar.gz`
- user can unpack file, enter folder and execute `present`

## Browser paths

when presentation is opened in browser few paths exists:
- `/` -> show presentation in selected aspect ratio
- `/print` -> presentation without forced aspect ratio (use for printing)
- `/login` -> path to log in admin credentials

## Customizations & security

- present will watch for three files:
Expand Down
8 changes: 7 additions & 1 deletion doc/README-end.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@
- user can start presentation with `present -f present.tar.gz`
- user can unpack file, enter folder and execute `present`
## Browser paths
when presentation is opened in browser few paths exists:
- `/` -> show presentation in selected aspect ratio
- `/print` -> presentation without forced aspect ratio (use for printing)
- `/login` -> path to log in admin credentials
## Customizations & security
- present will watch for three files:
Expand Down Expand Up @@ -49,5 +56,4 @@
![style](assets/examples/style.png)

- display code that is editable and runnable

![code](assets/examples/code.png)

0 comments on commit 417cf75

Please sign in to comment.