Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
brown-a2 committed Aug 29, 2023
1 parent b347a29 commit 0d7bd89
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
```
______ _ _____
| ____| | | | __ \
| |__ ___ ___ __| | | |__) |_ _ _ __ ___ ___ _ __
______ _ _____
| ____| | | | __ \
| |__ ___ ___ __| | | |__) |_ _ _ __ ___ ___ _ __
| __/ _ \/ _ \/ _` | | ___/ _` | '__/ __|/ _ \ '__|
| | | __/ __/ (_| | | | | (_| | | \__ \ __/ |
|_| \___|\___|\__,_| |_| \__,_|_| |___/\___|_|
| | | __/ __/ (_| | | | | (_| | | \__ \ __/ |
|_| \___|\___|\__,_| |_| \__,_|_| |___/\___|_|
```
```
[![Feed Parser Deployment](https://github.com/ministryofjustice/feed-parser/actions/workflows/cd.yaml/badge.svg)](https://github.com/ministryofjustice/feed-parser/actions/workflows/cd.yaml)

# FeedParser
Expand All @@ -24,3 +24,14 @@ To check if the image has been pushed into the ECR repo make sure in your termin
## Usage

We are currently running this application in [kubernetes using a cron manifest file](https://github.com/ministryofjustice/hale-platform/blob/main/helm_deploy/wordpress/templates/cron-feedparser.yaml) that periodically runs depending on the cron schedule.

## Local development

To run locally:

1. In this repo root directory run `make build`.
2. Run `make run`

To stop run `make down` .

Files will be exported to the `/output` folder rather then exported to s3.

0 comments on commit 0d7bd89

Please sign in to comment.