Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HADB committed Mar 19, 2024
1 parent 41c9c2c commit 390718c
Showing 1 changed file with 19 additions and 14 deletions.
33 changes: 19 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Font2svg server-side project, written in Python. (ETA: 2024Q2)
### Docker run

This will start a stateless instance of Font2svg api listening on the default port of 8000.

Notice that all your fonts uploaded will be lost if container stopped running.

```bash
Expand All @@ -28,10 +29,14 @@ If all goes well, you'll be able to access your font2svg api on `http://localhos

```bash
$ docker run -d --name font2svg-api \
-e ADMIN_TOKEN=your_admin_token \ # Secret token for admin operations
-e CACHE__ENABLED=true \ # Enable or disable cache, default: true
-e CACHE__PERSISTENT=true \ # If true, svg file will be cached, default: true
-e CACHE__MEM_CHARS_LIMIT=10000 \ # Maximum number of characters in memory cache
# Secret token for admin operations
-e ADMIN_TOKEN=your_admin_token \
# Enable or disable cache, default: true
-e CACHE__ENABLED=true \
# If true, svg file will be cached, default: true
-e CACHE__PERSISTENT=true \
# Maximum number of characters in memory cache
-e CACHE__MEM_CHARS_LIMIT=10000 \
-v /path/to/font2svg:/var/lib/font2svg/data \
-v /path/to/font2svg/logs:/var/lib/font2svg/logs \
-p 3001:8000 \
Expand Down Expand Up @@ -64,21 +69,21 @@ services:
## Benchmark
### Benchmark running command:
### Running command:
```
uvicorn src.main:app --log-level critical
```bash
$ uvicorn src.main:app --log-level critical
```

### Platform Info:

```
Device: Apple MacBook Pro(13-inch, M1, 2020)
Chip: Apple M1
Memory: 16GB
macOS: Sonoma 14.3.1 (23D60)
```
> **Device**: Apple MacBook Pro(13-inch, M1, 2020)
>
> **Chip**: Apple M1
>
> **Memory**: 16GB
>
> **System**: macOS Sonoma 14.3.1 (23D60)
### Results:

Expand Down

0 comments on commit 390718c

Please sign in to comment.