Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
fcoagz committed Sep 23, 2024
1 parent 1bf4117 commit cc42429
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

It is a Flask extension to view incidents caused by the server.

<img src="https://github.com/fcoagz/statuspage/blob/main/assets/dashboard.png?raw=true" style="border-radius: 10px;">
![Example Status](https://github.com/fcoagz/statuspage/blob/main/assets/dashboard.png?raw=true)

This is handled based on the requests that users make. Captures the server response and uses the conditional expression to quickly classify whether the request was successful or failed.

Expand All @@ -15,6 +15,7 @@ This is handled based on the requests that users make. Captures the server respo
Some of the HTTP states that the server takes into account are:

- `200 OK`: Indicates that the request has been completed successfully.

- `404 Not Found`: Indicates that the requested resource is not available on the server.

- `500 Internal Server Error`: Indicates that an internal server error has occurred while processing the client request.
Expand Down Expand Up @@ -50,6 +51,12 @@ You can configure which routes you want to be shown:
FlaskStatus(app, routes=['/'])
```

The default path is: `/status`. Although you can configure the route.

```py
FlaskStatus(app, url_prefix='/status')
```

- Define routes. The use of docstring. It will be used to define the route name. `# <ROUTE NAME>`

```py
Expand All @@ -61,7 +68,7 @@ def index():
return 'Welcome to API!', 200 # 200 is the status code
```

The default path is: `/status`
In case you have not defined the route name. By default, it will take the name of the endpoint role.

## API

Expand Down
11 changes: 9 additions & 2 deletions README_ES.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Es una extensión de Flask para visualizar incidentes provocados por el servidor.

<img src="https://github.com/fcoagz/statuspage/blob/main/assets/dashboard.png?raw=true" style="border-radius: 10px;">
![Example Status](https://github.com/fcoagz/statuspage/blob/main/assets/dashboard.png?raw=true)

Esto se maneja en función de las solicitudes que realizan los usuarios. Captura la respuesta del servidor y utiliza la expresión condicional para clasificar rápidamente si la solicitud fue exitosa o si ha fallado.

Expand All @@ -15,6 +15,7 @@ Esto se maneja en función de las solicitudes que realizan los usuarios. Captura
Algunos de los estados de HTTP que el servidor toma en cuenta son:

- `200 OK`: Indica que la solicitud ha sido completada con éxito.

- `404 Not Found`: Indica que el recurso solicitado no se encuentra disponible en el servidor.

- `500 Internal Server Error`: Indica que ha ocurrido un error interno en el servidor al procesar la solicitud del cliente.
Expand Down Expand Up @@ -50,6 +51,12 @@ Puedes configurar qué rutas quieres que se muestren:
FlaskStatus(app, routes=['/'])
```

La ruta por defecto es: `/status`. Aunque puedes configurar la ruta.

```py
FlaskStatus(app, url_prefix='/status')
```

- Definir rutas. El uso de docstring. Se utilizará para definir el nombre de la ruta. `# <NOMBRE DE LA RUTA>`

```py
Expand All @@ -61,7 +68,7 @@ def index():
return 'Welcome to API!', 200 # 200 is the status code
```

La ruta por defecto es: `/status`
En caso de que no hayas definido el nombre de la ruta. De forma predeterminada, tomará el nombre de la función del endpoint.

## API

Expand Down

0 comments on commit cc42429

Please sign in to comment.