Skip to content

Commit a3d038e

Browse files
authored
Migrate DockerHub account to PESUDev (#145)
* Migrate DockerHub account to PESUDev * Update README
1 parent 96d55d7 commit a3d038e

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
[![Lint](https://github.com/pesu-dev/auth/actions/workflows/lint.yaml/badge.svg)](https://github.com/pesu-dev/auth/actions/workflows/lint.yaml)
66
[![Deploy](https://github.com/pesu-dev/auth/actions/workflows/deploy-prod.yaml/badge.svg)](https://github.com/pesu-dev/auth/actions/workflows/deploy-prod.yaml)
77

8-
[![Docker Automated build](https://img.shields.io/docker/automated/aditeyabaral/pesu-auth?logo=docker)](https://hub.docker.com/r/aditeyabaral/pesu-auth/builds)
9-
[![Docker Image Version (tag)](https://img.shields.io/docker/v/aditeyabaral/pesu-auth/latest?logo=docker&label=build%20commit)](https://hub.docker.com/r/aditeyabaral/pesu-auth/tags)
10-
[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/aditeyabaral/pesu-auth/latest?logo=docker)](https://hub.docker.com/r/aditeyabaral/pesu-auth)
8+
[![Docker Automated build](https://img.shields.io/docker/automated/pesudev/pesu-auth?logo=docker)](https://hub.docker.com/r/pesudev/pesu-auth/builds)
9+
[![Docker Image Version (tag)](https://img.shields.io/docker/v/pesudev/pesu-auth/latest?logo=docker&label=build%20commit)](https://hub.docker.com/r/pesudev/pesu-auth/tags)
10+
[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/pesudev/pesu-auth/latest?logo=docker)](https://hub.docker.com/r/pesudev/pesu-auth)
1111

1212
A simple and lightweight API to authenticate PESU credentials using PESU Academy.
1313

@@ -30,13 +30,15 @@ returns the user's profile information. No personal data is stored.
3030
> All timestamps are in UTC.
3131
3232
> [!WARNING]
33-
> The live version is hosted on a free tier server. As a result, you might experience higher latency compared to a local
34-
> deployment.
33+
> The live version is hosted on a free tier server located in the United States. As a result, you *might* experience higher latencies and slower response times, compared to running the API locally or on a server closer to your location.
3534
3635
## How to run PESUAuth locally
3736

3837
Running the PESUAuth API locally is simple. Clone the repository and follow the steps below to get started.
3938

39+
> [!TIP]
40+
> We recommend running the API locally using Docker for ease of use, the best performance, and lowest latency.
41+
4042
### Running with Docker
4143

4244
This is the easiest and recommended way to run the API locally. Ensure you have Docker installed on your system. Run the
@@ -51,17 +53,17 @@ following commands to start the API.
5153
```
5254

5355
2. You can also pull the pre-built Docker image
54-
from [Docker Hub](https://hub.docker.com/repository/docker/aditeyabaral/pesu-auth/general) by running the
56+
from [Docker Hub](https://hub.docker.com/repository/docker/pesudev/pesu-auth/general) by running the
5557
following command:
5658
```bash
57-
docker pull aditeyabaral/pesu-auth:latest
59+
docker pull pesudev/pesu-auth:latest
5860
```
5961

6062
2. Run the Docker container
6163
```bash
6264
docker run --name pesu-auth -d -p 5000:5000 pesu-auth
6365
# If you pulled the pre-built image, use the following command instead:
64-
docker run --name pesu-auth -d -p 5000:5000 aditeyabaral/pesu-auth:latest
66+
docker run --name pesu-auth -d -p 5000:5000 pesudev/pesu-auth:latest
6567
```
6668

6769
3. Access the API at `http://localhost:5000/`

0 commit comments

Comments
 (0)