chore: rename to rf433-api

fcrespel · May 9, 2024 · f0432c4 · f0432c4
1 parent 8d5c0e7
commit f0432c4
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -5,7 +5,7 @@ on: [push, workflow_dispatch]
 env:
   DOCKER_REGISTRY: ghcr.io
   DOCKER_REPO: ${{ github.repository_owner }}
-  DOCKER_IMAGE: rc-server
+  DOCKER_IMAGE: rf433-api
   DOCKER_TAG: ${{ github.ref_name }}
   DOCKER_PLATFORM: linux/arm64
 

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Remote Control REST API
+# RF433 REST API
 
 REST API to use an RF 433 MHz transmitter as a remote control. It currently only supports the Chacon DIO 1.0 and Chacon 54662 protocols.
 
@@ -43,23 +43,23 @@ Optional arguments:
 A Docker image is also available for the arm64 architecture:
 
 ```
-docker run -it --rm --privileged -p 8001:8001 ghcr.io/fcrespel/rc-server:master [-h] [-a ADDRESS] [-p PORT] [-g GPIO] [-l LOG_LEVEL]
+docker run -it --rm --privileged -p 8001:8001 ghcr.io/fcrespel/rf433-api:master [-h] [-a ADDRESS] [-p PORT] [-g GPIO] [-l LOG_LEVEL]
 ```
 
 You may want to run it in the background using commands such as the following:
 
 ```
 # Create and start container
-docker run -d --name rc-server --privileged -p 127.0.0.1:8001:8001 ghcr.io/fcrespel/rc-server:master
+docker run -d --name rf433-api --privileged -p 127.0.0.1:8001:8001 ghcr.io/fcrespel/rf433-api:master
 
 # Stop server
-docker stop rc-server
+docker stop rf433-api
 
 # Start server
-docker start rc-server
+docker start rf433-api
 
 # Show live logs
-docker logs -f rc-server
+docker logs -f rf433-api
 ```
 
 NOTE: the API port is not secured, make sure to only expose it locally or to trusted clients.

diff --git a/app/server.py b/app/server.py
@@ -22,7 +22,7 @@ async def lifespan(app: FastAPI):
     wiringpi.pinMode(app.state.gpio, wiringpi.OUTPUT)
     yield
 
-app = FastAPI(title="Remote Control REST API", description="REST API to use an RF 433 MHz transmitter as a remote control", version="1.0", lifespan=lifespan)
+app = FastAPI(title="RF433 REST API", description="REST API to use an RF 433 MHz transmitter as a remote control", version="1.0", lifespan=lifespan)
 app.include_router(chacon54662_router)
 app.include_router(chacondio10_router)
 app.state.gpio = 0