From e282ca336853e9efbe119609af4d76bc05af5ce1 Mon Sep 17 00:00:00 2001
From: "H.G. Giorgis" <habtom@giorgis.io>
Date: Fri, 22 May 2015 00:50:39 -0400
Subject: [PATCH] readme update with list of libraries, and description

---
 .travis.yml |  6 ------
 README.md   | 62 +++++++++++++++++++++++++++++++++--------------------
 2 files changed, 39 insertions(+), 29 deletions(-)
 delete mode 100644 .travis.yml

diff --git a/.travis.yml b/.travis.yml
deleted file mode 100644
index 206e887..0000000
--- a/.travis.yml
+++ /dev/null
@@ -1,6 +0,0 @@
-language: go
-
-go:
-  - tip
-
-script: go test -v ./
\ No newline at end of file
diff --git a/README.md b/README.md
index ee37c34..196fe82 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,7 @@
-# goav [![Build Status](https://travis-ci.org/giorgisio/goav.svg?branch=master)](https://travis-ci.org/giorgisio/goav)
-Golang bindings for FFmpeg
-
-## Notice
-goav comes with ABSOLUTELY NO WARRANTY.
-
-## Installation
-
-go get github.com/giorgisio/goav
-
-export FFMPEG_ROOT=$HOME/ffmpeg
-
-export CGO_LDFLAGS="-L$FFMPEG_ROOT/lib/ -lavcodec -lavformat -lavutil -lswscale -lswresample -lavdevice -lavfilter"
-
-export CGO_CFLAGS="-I$FFMPEG_ROOT/include"
-
-export LD_LIBRARY_PATH=$HOME/ffmpeg/lib
-
+# goav
+Golang binding for FFmpeg
 
+A comprehensive binding to the ffmpeg video/audio manipulation library.
 
 ## Usage
 
@@ -26,7 +11,7 @@ import "github.com/giorgisio/goav/avformat"
 
 func main() {
 
-	filename := "/home/giorgis/media/sample2.mp4"
+	filename := "/home/giorgis/media/sample.mp4"
 
 	// Register all formats and codecs
 	avformat.Av_register_all()
@@ -40,14 +25,45 @@ func main() {
 }
 `````
 
+## Libraries
+
+* `avcodec` corresponds to the ffmpeg library: libavcodec [provides implementation of a wider range of codecs]
+* `avformat` corresponds to the ffmpeg library: libavformat [implements streaming protocols, container formats and basic I/O access]
+* `avutil`` corresponds to the ffmpeg library: libavutil [includes hashers, decompressors and miscellaneous utility functions]
+* `avfilter` corresponds to the ffmpeg library: libavfilter [provides a mean to alter decoded Audio and Video through chain of filters]
+* `avdevice` corresponds to the ffmpeg library: libavdevice [provides an abstraction to access capture and playback devices]
+* `swresample` corresponds to the ffmpeg library: libswresample [implements audio mixing and resampling routines]
+* `swscale` corresponds to the ffmpeg library: libswscale [implements color conversion and scaling routines]
+
+
+## Installation
+
+``` sh
+go get github.com/giorgisio/goav
+``` 
+
+[FFMPEG libraries] (https://github.com/FFmpeg/FFmpeg/blob/master/INSTALL.md)
+
+
+``` sh
+export FFMPEG_ROOT=$HOME/ffmpeg
+export CGO_LDFLAGS="-L$FFMPEG_ROOT/lib/ -lavcodec -lavformat -lavutil -lswscale -lswresample -lavdevice -lavfilter"
+export CGO_CFLAGS="-I$FFMPEG_ROOT/include"
+export LD_LIBRARY_PATH=$HOME/ffmpeg/lib
+``` 
+
 ## TODO
 
-- [ ] Errors
-- [ ] Tests
-- [ ] Review library methods
+- [ ] Returning Errors
+- [ ] Review included/excluded functions from each library
+- [ ] Go Tests
 - [ ] Possible restructuring packages
 - [x] Tutorial01.c
 - [ ] More Tutorial
 
 ## License
-This library is under the [MIT License](http://opensource.org/licenses/MIT)
\ No newline at end of file
+This library is under the [MIT License](http://opensource.org/licenses/MIT)
+
+
+## Notice
+goav comes with absolutely no warranty.