alihan/textual-web
1
0
Fork 0
mirror of https://github.com/Textualize/textual-web.git synced 2025-10-17 02:36:40 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Will McGugan
2023-09-05 14:26:41 +01:00
committed by GitHub
parent 4d018b3515
commit f5d34c0055
1 changed files with 16 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -2,7 +2,7 @@
Textual Web publishes [Textual](https://github.com/Textualize/textual) apps and terminals on the web.
Currently in a **prototype** stage (pre-beta), but available for testing.
Currently in a beta phase — help us test!
## Getting Started
@@ -59,7 +59,10 @@ This will generate another URL, which will present you with your terminal in you
When you serve a terminal in this way it will generate a random public URL.
Don't share this with anyone you wouldn't trust to have access to your machine.
> [!WARNING]
> Don't share this with anyone you wouldn't trust to have access to your machine.
## Configuration
@@ -98,6 +101,17 @@ Click any of the links to serve the respective app:
<img width="1131" alt="Screenshot 2023-08-22 at 10 42 25" src="https://github.com/Textualize/textual-web/assets/554369/d25f3061-bc98-48b9-b4d0-1bab61d401b1">
### Slugs
Textual Web will derive the slug (text in the URL) from the name of the app.
You can also set it explicitly with the slug parameter.
```toml
[app.Calculator]
command = "python calculator.py"
slug = "calc"
```
### Terminal configuration
> [!NOTE]