Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
toddbirchard authored Jun 2, 2024
1 parent 1fe2e91 commit c4f8381
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Blog Webhook API
# Ghost Webhook API

![Python](https://img.shields.io/badge/Python-^3.10-blue.svg?logo=python&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a)
![FastAPI](https://img.shields.io/badge/FastAPI-^v0.89.1-blue.svg?longCache=true&logo=fastapi&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
Expand All @@ -14,15 +14,15 @@

![Blog Webhook API](./.github/blog-webhook-api@2x.png?raw=true)

Webhook-driven API to make maintaining blogs easier. Dynamically handles optimizations including image compression, content sanitation, alerting, and feature enablement via data aggregate (suggested searches, trending posts, etc)
Standalone API to compliment Ghost blogs. Accepts Ghost webhook events tiggers & executes task to optimize content and serve new features. Handles optimizations including image compression, content sanitation, alerting, and feature enablement via data aggregate (suggested searches, trending posts, etc)

## Installation

Get up and running with `make deploy`:

```shell
git clone https://github.com/toddbirchard/blog-webhook-api.git
cd blog-webhook-api
git clone https://github.com/toddbirchard/ghost-webhook-api.git
cd ghost-webhook-api
make deploy
```

Expand Down Expand Up @@ -85,4 +85,4 @@ Insight to scenarios where Authors likely need assistance.
Notifications when user activity is made on project repos.

* **POST** `/github/pr/`: Trigger SMS notification when contributors open a Github PR in a specified Github org.
* **POST** `/github/issue/`: Trigger SMS notification when contributors open a Github issue in a specified Github org.
* **POST** `/github/issue/`: Trigger SMS notification when contributors open a Github issue in a specified Github org.

0 comments on commit c4f8381

Please sign in to comment.