README.md in jekyll-octopod-0.3.0 vs README.md in jekyll-octopod-0.4.0
- old
+ new
@@ -1,84 +1,67 @@
# Jekyll - Octopod
-
+<img align="right" src="assets/img/logo.jpg" alt="logo">
+A podcast publishing extension for the static site generator [Jekyll](https://jekyllrb.com/)
-A Podcasting publishing extension for the static site generator [Jekyll](https://jekyllrb.com/).
+## tl;dr
-## Prerequesites
+You generate a static web site for your podcast on your own computer, test drive it and sync it to your web space.
-The programming language Ruby and it's package manager Bundler.
+So no Wordpress, PHP, Ruby other scripting language, database management system or any other dynamic component is needed on your server.
+Thich increases security immensely.
-Nice installation guides for the different operating systems can be found at
-the [Rails Girls Website](http://guides.railsgirls.com/install). You can stop
-right before installing Rails, because we do not depend on Ruby on Rails here.
+## Tell me more!
-You can check, if you succeeded, by entering
-```
-$ ruby -v
-$ gem -v
-```
-at the command prompt. Both commands should return version greater or equal 2.0 .
+If you want to take a look: See (and listen to) Stefan's podcast [Aua-Uff-Code!](https://aua-uff-co.de).
-## Installation
+The page, you will get, when you follow the installation instructions later, looks like this:
-```
-$ gem install jekyll
-$ jekyll new name-of-my-podcast
-$ cd name-of-my-podcast
-```
+
-Create file Gemfile with the contents:
+Technically speaking, jekyll-octopod is a Jekyll plugin and a Ruby Gem. It
+contains of scripts, templates, helpers and extensions to publish your
+podcasts the cool text file lover's way.
-```
-source 'http://rubygems.org'
-gem 'jekyll-octopod'
-```
+If you are not afraid of the command line of your computer and text files are the
+stuff to heat up your geeky little heart, jekyll-octopod may be worth a trial
+to publish your podcasts.
-Install the dependencies and run the setup script via:
+The underlying assumptions of Octojekyll-octopodpod are that static content
+should be delivered statically and text files are the perfect way to handle
+podcast metadata. So jekyll-octopod makes it easy to generate and deploy a
+website and feeds for your podcast out of one textfile and at least one audio
+file per episode.
-```
-$ bundle install
-$ octopod setup
-```
-Update the configuration settings in the configation file `_config.yaml` in the
-application directory.
+## Features
- * You might want to change the images and logos in ...
- * You might want to delete the demo episode files
+Jekyll-Octopod brings innately:
+* iTunes ready episode feeds for different file formats (e.g. mp3, ogg, m4a)
+* a ready to use [Bootflat](http://bootflat.github.io/) and [Twitter Bootstrap](http://twitter.github.com/bootstrap/) based, responsible (i.e. mobile friendly) layout modifiable to your heart's desire.
+* [Flattr](https://flattr.com/) support on the website and in the episode feed
+* [Twitter](https://twitter.com) integration on the website
+* comments via [Disqus](http://disqus.com/)
+* [Podlove Web Player](http://podlove.org/podlove-web-player/) in it's current version 3.0
+* Static player pages that are embeddable in iframes at your other or affiliates' sites
+* [Podlove Alternate Feeds](http://podlove.org/alternate-feeds/)
+* [Podlove Simple Chapters](http://podlove.org/simple-chapters/)
+* [Podlove Subscribe Button](http://podlove.org/podlove-subscribe-button/) for easy podcast subscription on any operating system, including mobile phones.
+* https compatibility
+* Google search integration
+* easy creation of show notes
+**Is this production ready?**
-## Usage
+We use it in production, so we believe it is.
+But it is very likely, that it still contains bugs. And there is no guarantee that behavior will change with the next update :-).
+Hopefully you are brave enough to play with this cute little toy anyway.
-## Contributions
-are welcome!
+## Documentation
+Detailed documentation is provided in the [Wiki](https://github.com/informatom/jekyll-octopod/wiki)
+
## Maintainer
Stefan Haslinger <mailto:stefan.haslinger@informatom.com>
-
-
-## Credits
-
-This Gem is sitting on the shoulder of giants, lots of the code was not written
-by me and/or depends on other code.
-
-Especially to be mentioned: Arne Eilermann eilermann@lavabit.com who started and
-created Octopod https://github.com/pattex/octopod
-
-## License
-
-[Licensend under the MIT-License](LICENSE)
-
-The following assets from seperate projects are packaged in this repo:
-* The cute Octopod Logo is by Thekla "TeMeL" Löhr, http://www.temel-art.de/, CC BY 3.0 Germany License
-* Podlove Webplayer, version 3.0.0-beta.3, http://podlove.org/podlove-web-player/, BSD 2-Clause License
-* Bootflat, version 2.0.4, http://bootflat.github.io/, MIT License
-* Bootstrap, version 3.3.0 http://getbootstrap.com/, MIT License
-* Glyphicons, http://glyphicons.com/, are licensed via Bootstrap
-* Font Awesome, version 4.5.0, http://fontawesome.io/, Font: SIL OFL 1.1, CSS: MIT License
-* iCheck, version 1.0.1, http://git.io/arlzeA, MIT License
-* JQuery, version 1.11.3., https://jquery.com/, MIT License
-* Demo Audio from Bensound, http://www.bensound.com/royalty-free-music, CC BY-ND 3.0 License