Skip to content

Commit

Permalink
Merge pull request #59 from rawfunkmaharishi/words
Browse files Browse the repository at this point in the history
Tweak README
  • Loading branch information
Sam Pikesley committed Dec 22, 2015
2 parents cd00064 + e7b13da commit 65d5068
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

#Purdie

We have music on SoundCloud, photos on Flickr, and videos on Vimeo, and we want to feature them on [http://rawfunkmaharishi.uk/](http://rawfunkmaharishi.uk/). Up until now, this has been managed by curating, by hand (or [very shonky scripts](https://github.com/rawfunkmaharishi/rawfunkmaharishi.github.io/blob/master/flickriser.rb)), [bits](https://github.com/rawfunkmaharishi/rawfunkmaharishi.github.io/blob/master/_data/sounds.yml) [of](https://github.com/rawfunkmaharishi/rawfunkmaharishi.github.io/blob/master/_data/pictures.yml) [YAML](https://github.com/rawfunkmaharishi/rawfunkmaharishi.github.io/blob/master/_data/videos.yml) to feed into Jekyll, but this gets old quickly, especially when you run into things like SoundCloud's decision to only expose the track ID deep inside the embeddable iframe code.
My band has music on SoundCloud, photos on Flickr, and videos on Vimeo, and we want to feature them on [http://rawfunkmaharishi.uk/](http://rawfunkmaharishi.uk/). Up until now, this has been managed by curating, by hand (or [very shonky scripts](https://github.com/rawfunkmaharishi/rawfunkmaharishi.github.io/blob/master/flickriser.rb)), [bits](https://github.com/rawfunkmaharishi/rawfunkmaharishi.github.io/blob/master/_data/soundcloud.yml) [of](https://github.com/rawfunkmaharishi/rawfunkmaharishi.github.io/blob/master/_data/flickr.yml) [YAML](https://github.com/rawfunkmaharishi/rawfunkmaharishi.github.io/blob/master/_data/vimeo.yml) to feed into Jekyll, but this gets old quickly, especially when you run into things like SoundCloud's decision to only expose the track ID deep inside the embeddable iframe code.

But this is dumb. It's 2015 and everything has an API, so let's build a robot to do this stuff properly!

Expand Down Expand Up @@ -38,7 +38,7 @@ or

###Configuration

You need to create a *_sources* directory in your Jekyll project, containing files with one-URL-per-line, like this:
You need to create a `_sources` directory in your Jekyll project, containing files with one-URL-per-line, like this:

https://soundcloud.com/rawfunkmaharishi/hexaflexagon-1
https://soundcloud.com/rawfunkmaharishi/junalbandi-3
Expand All @@ -47,13 +47,13 @@ It also resolves sets/albums on all of the supported services, so this kind of t

https://www.flickr.com/photos/pikesley/sets/72157648589429938/

####Notes about *_sources*:
####Notes about `_sources`:

* Purdie maps each input file onto an output file, replacing any extension with _.yaml_, something like:
* \_sources/flickr.csv -> \_data/flickr.yaml
* \_sources/pictures.source -> \_data/pictures.yaml
* \_sources/soundcloud.sounds -> \_data/soundcloud.yaml
* \_sources/vimeo -> \_data/vimeo.yaml
* `_sources/flickr.csv` -> `_data/flickr.yaml`
* `_sources/pictures.source` -> `_data/pictures.yaml`
* `_sources/soundcloud.sounds` -> `_data/soundcloud.yaml`
* `_sources/vimeo` -> `_data/vimeo.yaml`

* Mixing up different services in the same input file makes no sense to Purdie. Don't do this
* If a URL appears multiple times in a resolved list, only the first appearance will be propagated to the output file
Expand All @@ -75,7 +75,7 @@ And then you can run

purdie fetch

(`fetch` is the default task (in fact currently the only task), so just `purdie` will work) and it will dump out YAML files into *_data*:
(`fetch` is the default task (in fact currently the only task), so just `purdie` will work) and it will dump out YAML files into `_data`:

flickr.yaml
pictures.yaml
Expand All @@ -86,7 +86,7 @@ ready for Jekyll to consume.

###Customisation

You can supply your own *_config/purdie.yaml* file to specify a few things:
You can supply your own `_config/purdie.yaml` file to specify a few things:

# Flickr photos are happy to have a null title
default_title: Raw Funk Maharishi
Expand Down

0 comments on commit 65d5068

Please sign in to comment.