From 12d8b87cc1fed4eb1f0c5c607f94ecd6ec816729 Mon Sep 17 00:00:00 2001 From: cupcakearmy Date: Sun, 31 May 2026 23:31:36 +0200 Subject: [PATCH] cleanup readme --- README_ES.md | 14 +++++++------- README_zh-CN.md | 22 +++++++++++----------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/README_ES.md b/README_ES.md index 9b2dc54..890e21d 100644 --- a/README_ES.md +++ b/README_ES.md @@ -43,7 +43,7 @@ Puedes revisar la documentación sobre el CLI en este [readme](./packages/cli/RE - enviar texto o archivos - el servidor no puede desencriptar el contenido debido a que la encriptación se hace del lado del cliente -- restriccion de vistas o de tiempo +- restricción de vistas o de tiempo - en memoria, sin persistencia - compatibilidad obligatoria con el modo oscuro @@ -66,7 +66,7 @@ se usa para guardar y recuperar la nota. Después la nota es encriptada con la < | `MAX_VIEWS` | `100` | Número máximo de vistas. | | `MAX_EXPIRATION` | `360` | Tiempo máximo de expiración en minutos. | | `ALLOW_ADVANCED` | `true` | Permitir configuración personalizada. Si se establece en `false` todas las notas serán de una sola vista. | -| `ID_LENGTH` | `32` | Establece el tamaño en bytes de la `id` de la nota. Por defecto es de `32` bytes. Esto es util para reducir el tamaño del link. _Esta configuración no afecta el nivel de encriptación_. | +| `ID_LENGTH` | `32` | Establece el tamaño en bytes de la `id` de la nota. Por defecto es de `32` bytes. Esto es útil para reducir el tamaño del link. _Esta configuración no afecta el nivel de encriptación_. | | `VERBOSITY` | `warn` | Nivel de verbosidad del backend. [Posibles valores](https://docs.rs/env_logger/latest/env_logger/#enabling-logging): `error`, `warn`, `info`, `debug`, `trace` | | `THEME_IMAGE` | `""` | Imagen personalizada para reemplazar el logo. Debe ser accesible públicamente. | | `THEME_TEXT` | `""` | Texto personalizado para reemplazar la descripción bajo el logo. | @@ -75,18 +75,18 @@ se usa para guardar y recuperar la nota. Después la nota es encriptada con la < ## Despliegue -> ℹ️ Se requiere `https` de lo contrario el navegador no soportará las funciones de encriptacón. +> ℹ️ Se requiere `https` de lo contrario el navegador no soportará las funciones de encriptación. > ℹ️ Hay un endpoint para verificar el estado, lo encontramos en `/api/health/`. Regresa un código 200 o 503. ### Docker -Docker es la manera más fácil. Aquí encontramos [la imágen oficial](https://hub.docker.com/r/cupcakearmy/cryptgeon). +Docker es la manera más fácil. Aquí encontramos [la imagen oficial](https://hub.docker.com/r/cupcakearmy/cryptgeon). ```yaml # docker-compose.yml -version: '3.8' +version: "3.8" services: redis: @@ -161,7 +161,7 @@ cargo install cargo-watch **Ejecutar** -Asegurate de que docker se esté ejecutando. +Asegúrate de que docker se esté ejecutando. ```bash pnpm run dev @@ -191,7 +191,7 @@ pnpm run test:local ## Seguridad -Por favor dirigite a la sección de seguridad [aquí](./SECURITY.md). +Por favor dirígete a la sección de seguridad [aquí](./SECURITY.md). --- diff --git a/README_zh-CN.md b/README_zh-CN.md index 7d88b3c..803df38 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -47,15 +47,15 @@ _加密鸽_ 是一个受 [_PrivNote_](https://privnote.com)项目启发的安全 ## 环境变量 -| 变量名称 | 默认值 | 描述 | -| ----------------- | ---------------- | --------------------------------------------------------------------------------- | -| `REDIS` | `redis://redis/` | Redis 连接 URL。 | -| `SIZE_LIMIT` | `1 KiB` | 最大请求体(body)限制。有关支持的数值请查看 [字节单位](https://docs.rs/byte-unit/) | -| `MAX_VIEWS` | `100` | 密信最多查看次数限制 | -| ` MAX_EXPIRATION` | `360` | 密信最长过期时间限制(分钟) | -| `ALLOW_ADVANCED` | `true` | 是否允许自定义设置，该项如果设为`false`，则不会显示自定义设置模块 | -| `THEME_IMAGE` | `""` | 自定义 Logo 图片，你在这里填写的的图片链接必须是可以公开访问的。 | -| `THEME_TEXT` | `""` | 自定义在 Logo 下方的文本。 | +| 变量名称 | 默认值 | 描述 | +| ---------------- | ---------------- | --------------------------------------------------------------------------------- | +| `REDIS` | `redis://redis/` | Redis 连接 URL。 | +| `SIZE_LIMIT` | `1 KiB` | 最大请求体(body)限制。有关支持的数值请查看 [字节单位](https://docs.rs/byte-unit/) | +| `MAX_VIEWS` | `100` | 密信最多查看次数限制 | +| `MAX_EXPIRATION` | `360` | 密信最长过期时间限制(分钟) | +| `ALLOW_ADVANCED` | `true` | 是否允许自定义设置，该项如果设为`false`，则不会显示自定义设置模块 | +| `THEME_IMAGE` | `""` | 自定义 Logo 图片，你在这里填写的的图片链接必须是可以公开访问的。 | +| `THEME_TEXT` | `""` | 自定义在 Logo 下方的文本。 | ## 部署 @@ -69,7 +69,7 @@ Docker 是最简单的部署方式。这里是[官方镜像的地址](https://hu ```yaml # docker-compose.yml -version: '3.8' +version: "3.8" services: redis: @@ -107,7 +107,7 @@ services: - 域名 `example.org` ```yaml -version: '3.8' +version: "3.8" networks: proxy: