Skip to content

Commit 97f55cf

Browse files
authored
Update README.md
1 parent 5217fdf commit 97f55cf

File tree

1 file changed

+29
-4
lines changed

1 file changed

+29
-4
lines changed

README.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,32 @@
11
# textual-serve
22

3-
Textual-serve turns your [Textual](https://github.com/textualize/textual) app in to a web application.
3+
Every [Textual](https://github.com/textualize/textual) application in now a web application.
44

5+
With 3 lines of code, any Textual app can run in the browser.
6+
7+
8+
9+
10+
<table>
11+
<tr>
12+
<td>
13+
<p>This is <a href="https://github.com/darrenburns/posting">Posting</a> running in the terminal.</p>
14+
</td>
15+
<td>
16+
<img src="https://github.com/Textualize/textual-serve/assets/554369/14120e6e-bd8c-4620-a9fc-7cf41e3e994b" width="100%"/>
17+
</td>
18+
</tr>
19+
<tr>
20+
<td>
21+
<p>This is <a href="https://github.com/darrenburns/posting">Posting</a> running in the <em>browser</em>.</p>
22+
</td>
23+
<td>
24+
<img src="https://github.com/Textualize/textual-serve/assets/554369/cfa66f9b-02a0-4335-a127-e5a75c6f859d" width="100%"/>
25+
</td>
26+
</tr>
27+
</table>
28+
29+
---
530

631
## Getting Started
732

@@ -16,21 +41,21 @@ pip install textual-serve
1641

1742
## Creating a server
1843

19-
The API is super simple. First import the Server class:
44+
First import the Server class:
2045

2146
```python
2247
from textual_serve.server import Server
2348
```
2449

25-
Then create a server instance and pass the command that launches your Textual app:
50+
Then create a `Server` instance and pass the command that launches your Textual app:
2651

2752
```python
2853
server = Server("python -m textual")
2954
```
3055

3156
The command can be anything you would enter in the shell, as long as it results in a Textual app running.
3257

33-
Finally, call the `serve` command:
58+
Finally, call the `serve` method:
3459

3560
```python
3661
server.server()

0 commit comments

Comments
 (0)