From 1865c16ea020aa9293a252da209ec78c9ae22863 Mon Sep 17 00:00:00 2001 From: Eefret Date: Sun, 21 Sep 2014 14:16:13 -0400 Subject: [PATCH] modifying Readme.md --- README.md | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dab0811..8c72eb5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,33 @@ -go-imdb +The Open Movie Database API ======= -Imdb API in golang +Author: Christopher T. Herrera (eefretsoul AT gmail DOT com) + +This API uses the [omdbapi.com](http://omdbapi.com/) API by Brian Fritz + +*** +### OMDBAPI.com +This is an excellent open database for movie and film content. + +I *strongly* encourage you to check it out and contribute to keep it growing. + +### http://www.omdbapi.com +*** +Project Usage +------------- +The API usage is very simple. Just import the go-imdb package + import ( + imdb "github.com/eefret/go-imdb" + ) + +And use any of the methods + + res, err := imdb.SearchMovies("The fifth element", "") + res2, err := imdb.GetMovieByTitle("True Grit", "1969") + res3, err := imdb.GetMovieByImdbId("tt2015381") + +See the project documentation to see the Response Objects and stuff + +Project Documentation +--------------------- +The automatically generated documentation can be found in [godocs](http://godoc.org/github.com/eefret/go-imdb)