Permalink
Browse files

Documentation improvements.

  • Loading branch information...
1 parent 7157009 commit 8ac95063b29679791f057a757cde245716c44c4b Bèr Kessels committed Mar 26, 2013
Showing with 60 additions and 13 deletions.
  1. +55 −8 README.md
  2. +5 −5 tubemp.rb
View
@@ -1,11 +1,58 @@
-# About
+# tubemp
-# Author
+> Nuke all the privacy-bugs from YouTube embeds
-# Requirements
+tubemp is a tiny web-application which creates and serves thumbnail-images from YouTube embed-codes. These images link to the video and look like embedded videos.
-# TODOs
-* Write this READMe
-* improve the Copy/pasting; auto-select, copy-to-clipboard button.
-* introduce a JSON-API
-* make a wordpress and Drupal module
+It offers a replacement for embedding YouTube videos on your site. A
+replacement without third-party cookies and tracking "bugs" following your
+visitors.
+
+Many countries (most notably the E.U-countries) don't allow third party
+trackers on many of their sites. Many site-owners don't want to place
+content on their websites that allows companies like Google to track
+their visitors.
+
+Placing an image that *looks* like a YouTube embed, but served from your
+own domain, is a good solution for all this.
+
+This tiny application aids in that.
+
+## Installation
+
+### The quick way
+
+1. `git clone https://github.com/berkes/tubemp.git`
+1. `cd tubemp`
+1. `bundle install`
+1. `ruby tubemp.rb`
+1. Open a browser and visit localhost:4567
+
+In some near future, this project will be made into a gem, which
+simplifies the installation and running greatly.
+
+### The long way (nginx and passenger)
+
+todo.
+
+## Author and Contributors
+
+[Bèr `berkes` Kessels](http://berk.es)
+
+## Requirements
+
+Bundler installs everything, but for reference:
+
+* Sinatra
+* RMagick
+* [video_info](https://rubygems.org/gems/video_info) by Thibaud Guillaume-Gentil
+* rspec for testing and development
+
+## TODOS
+* Write this README.
+* Write installation instructions.
+* Make a gem into this, allowing a simple `gem install tubemp && tubemp`
+ to run your own server.
+* Improve the Copy/pasting; auto-select, copy-to-clipboard button.
+* Introduce a JSON-API.
+* Make a wordpress and Drupal module, using that API.
View
@@ -98,19 +98,19 @@
<h2>How does it work?</h2>
</div>
<div class="large-4 columns">
-<div class="panel">
+ <div class="panel">
<h2>1. <small>Provide the YouTube-code</small></h2>
<p>Paste your originial YouTube embed-code, the ID or the video URL in the field above, and press the button.</p>
- <p>tubemp is a play on the word <a href="">EMP</a> and tube. Tube, referring to YouTube, EMP being a military (side)effect, which disables many electronic devises, also electronics that spy on you.</p>
-</div>
+ <p>tubemp is a play on the word <a href="https://en.wikipedia.org/wiki/Electromagnetic_pulse">EMP</a> and tube. Tube, referring to YouTube, EMP being a military (side)effect, which disables many electronic devises, also electronics that spy on you.</p>
+ </div>
</div>
<div class="large-4 columns"><div class="panel">
<h2>2. <small>tubemp creates an image that looks like a youtube-player</small></h2>
- <p>Copy and paste the code you get onto your site. You can either choose to place a simple image, or one that has a "YouTube" play icon on it.<br/>
+ <p>Copy and paste the code you get onto your site. You can either choose to place a simple image, or one that has a YouTube play icon sticked to it.<br/>
This code we provide, links to the original video-page on YouTube. The image is served from the tubemp server and domain.
</p>
<p>Now only the site who created the new embed-code can track your visitors! You probably don't want that either,
- so you probably want to <a href="">install this tubemp</a> on your own server and domain, because it is <a href="">Open Source Software</a>. Or you can <a href="">have me do that installation for you</a>
+ so you probably want to <a href="https://github.com/berkes/tubemp#installation">install this tubemp</a> on your own server and domain, because it is <a href="https://github.com/berkes/tubemp">Open Source Software</a>. Or you can <a href="http://berk.es/about.html">have me do that installation for you</a>
</p>
</div>
</div>

0 comments on commit 8ac9506

Please sign in to comment.