Add some README cruft
This commit is contained in:
parent
6b053d5cb4
commit
8e93dd055e
15
README.md
15
README.md
@ -1,7 +1,16 @@
|
|||||||
# PHP Project Template
|
# Baleen
|
||||||
|
|
||||||
This is a template for PHP projects. It includes a basic project structure, with Doctrine ORM
|
Podcast & RSS feed filtering
|
||||||
|
|
||||||
|
## What is it
|
||||||
|
|
||||||
|
A little service that takes an RSS feed and allows you to apply filters to the feed items, producing a new RSS feed link.
|
||||||
|
|
||||||
|
## Why?
|
||||||
|
|
||||||
|
Apple Podcasts doesn't have decent filtering/playlist creation tooling, and I wanted to split some of the podcasts I subscribe to into some of the different episode variants they produce.
|
||||||
|
|
||||||
|
It's called Baleen, because that's what whales use to filter out the krill from the water.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@ -11,7 +20,7 @@ This is a template for PHP projects. It includes a basic project structure, with
|
|||||||
|
|
||||||
## Running locally
|
## Running locally
|
||||||
|
|
||||||
1. Run `php -S localhost:8000 -t public` to start the web server
|
1. Run `php -S localhost:8000` to start the web server
|
||||||
|
|
||||||
## Running tests
|
## Running tests
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user